add public api markers
Review Request #3417 - Created Feb. 3, 2016 and submitted
|benjyw, kwlzn, patricklaw, stuhood, zundel|
Based on a discussion on pants slack, a method of marking methods as public using docstrings was proposed. This RB is an
example of how this markup would happen. This is part of the effort discussed in:
- Add markers to public api methods and classes
passes on personal fork.
CI green: https://travis-ci.org/pantsbuild/pants/builds/106836984
When a class is ':API: public', should we just assume that all of its non-
_privatemethods are public as well?
Would need to change existing classes a bit in order to not expose implementation details of the class... but that should be a much smaller problem, since it only involves changing methods of public classes, rather than renaming private classes.