diff options
| author |   Tim Harder <radhermit@gmail.com> | 2021-02-13 20:07:03 -0700 |
|---|---|---|
| committer | Tim Harder <radhermit@gmail.com> | 2021-02-13 20:08:45 -0700 |
| commit | e5c210131f601d335f640f0456e8d3f287d3d7df (patch) | |
| tree | 7708c7f5d0dba01a75633f7eb2782d39a47e0eda /doc | |
| parent | doc: bump copyright date (diff) | |
| download | pkgcheck-e5c210131f601d335f640f0456e8d3f287d3d7df.tar.gz pkgcheck-e5c210131f601d335f640f0456e8d3f287d3d7df.tar.bz2 pkgcheck-e5c210131f601d335f640f0456e8d3f287d3d7df.zip | |
doc: update api docs
Fixes #286.
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/api.rst | 15 |
1 files changed, 10 insertions, 5 deletions
diff --git a/doc/api.rst b/doc/api.rst index a2f006b1..6c58db50 100644 --- a/doc/api.rst +++ b/doc/api.rst @@ -1,10 +1,15 @@ API Documentation ================= -Modules -------- +Third party usage of pkgcheck's API should always import from the pkgcheck +module. Any module or functionality that can't be accessed directly from the +main module is not considered to be stable and should be avoided. -.. autosummary:: - :toctree: api +Proper API usage example: - pkgcheck +.. code-block:: python + + from pkgcheck import scan + + for result in scan(['-r', '/path/to/ebuild/repo']): + print(result) |