search

GothenburgBitFactory / bugwarrior

Pull github, bitbucket, and trac issues into taskwarrior
http://pypi.python.org/pypi/bugwarrior
GNU General Public License v3.0
736 stars 209 forks source link

[RFC] Document Python API #791

Open ryneeverett opened 3 years ago

ryneeverett commented 3 years ago

From #784:

Bugwarrior is likely being used as a library by some folks and semver communicates the API compatibility. In my opinion internal API compatibility is not a reasonable expectation for applications unless the API is documented or it is at least communicated by the maintainers that usage as a library is supported. @coddingtonbear does not agree with this. Perhaps we can agree that documenting the API or at least the fact that library usage is supported wouldn't do any harm.