Add public api markers

Review Request #3727 — Created April 20, 2016 and submitted

molsen
pants
2710, 3229
pants-reviews
benjyw, gmalmquist, jsirois, mateor, stuhood, zundel
add public api markers to several modules

* base
* backend
* engine
* console
* binaries

CI pending: https://travis-ci.org/pantsbuild/pants/builds/124557710

ST
  1. 
      
  2. src/python/pants/binaries/thrift_binary.py (Diff revision 1)
     
     
     
     
     

    Once you've called this method, you need to call one or more of the methods of the returned class... I expect there are some other public things in here. Ditto above.

  3. 
      
BE
  1. Ship It!
  2. 
      
MA
  1. Can you post what you are using to determine API usage, I think I saw a snippet floating around.

    We have written several plugins since Benjy last generated a report for Foursquare - I would like to check it against our current codebase as we get close to the final list of public APIs. I am positive we use some currently private API - and probably some of them will stay private which is okay.

    1. There were some OSS pants bugs about plugin usage: https://github.com/pantsbuild/pants/issues/2586 and https://github.com/pantsbuild/pants/issues/2587 I've been using those to check if things likely need to be marked public. For twitter code I've been able to look at our actual plugins to see how they are used.

    2. Thankfully if you need an api added thats very easy... it's removing them that is problematic.

    3. Okay, thanks. Here is the current list of implemented API from our plugins - let me know if anything looks obviously out of bounds (I am sure that there is). I will dig into it a bit today.

      https://gist.github.com/mateor/c5eb759508d023448ac2affaf3f451df

  2. 
      
MA
  1. Ship It!
  2. 
      
MO
MO
Review request changed

Status: Closed (submitted)

Change Summary:

commit 3fb4641ad3bf20287e6731a1635570468e12c319

Loading...