Set public API markers for subsystem, process, reporting and scm

Review Request #3551 — Created March 9, 2016 and submitted

molsen
pants
2710, 3027
3752
pants-reviews
benjyw, dturner-tw, gmalmquist, jsirois, stuhood

Set public API markers for subsystem, process, reporting and scm

The following modules were reviewed and all api's were left as private. As
far as I can tell these modules are not currently used by plugins.

  • pants.reporting.html_reporter
  • pants.reporting.invalidation_report
  • pants.reporting.linkify
  • pants.reporting.plaintext_reporter
  • pants.reporting.plaintext_reporter_base
  • pants.reporting.quiet_reporter
  • pants.reporting.report
  • pants.reporting.reporter
  • pants.reporting.reporting
  • pants.reporting.reporting_server
  • pants.reporting.reporting_utils
  • pants.scm.scm
  • pants.subsystem.subsystem_client_mixin
  • pants.process.pidlock
  • pants.process.xargs

CI green: https://travis-ci.org/pantsbuild/pants/builds/116764012

  • 0
  • 0
  • 4
  • 0
  • 4
Description From Last Updated
  1. 
      
  2. src/python/pants/scm/git.py (Diff revision 1)
     
     
     

    Should check with Nick, but I expect that this wasn't really intended to be public... the subclass we have should almost certainly live upstream as an option.

    1. I agree. We should upstream our subclass.

  3. 
      
  1. I think Scm should be marked public too.

  2. src/python/pants/scm/git.py (Diff revision 1)
     
     

    I think we shouldn't make this public, and instead create the factory method from the TODO and make that public.

    The worktree property of Scm should be how plugins get this piece of information.

  3. src/python/pants/scm/git.py (Diff revision 1)
     
     

    I think this public mark should move to the Scm class.

  4. src/python/pants/subsystem/subsystem.py (Diff revision 1)
     
     
     
     
     
     
     
     
     
     
     
     
     
     
     
     
     
     

    These should be marked public as well.

  5. src/python/pants/subsystem/subsystem.py (Diff revision 1)
     
     
     

    I think this implies that the __init__ ought to be public as well.

  6. 
      
  1. Ship It!
  2. 
      
  1. Ship It!
  2. 
      
  1. Ship It!
  2. 
      
Review request changed

Status: Closed (submitted)

Change Summary:

commit 3b7aaf2c967bf779b84fe51813d46b8b3e5ba466

Loading...