VimPlug/jedi
1
0
Fork 1
mirror of https://github.com/davidhalter/jedi.git synced 2026-01-03 10:43:26 +08:00
Code Issues Actions Packages Projects Releases Wiki Activity

sphinx dev: make API documentation clearer

Browse Source
This commit is contained in:
David Halter
2013-02-05 00:06:44 +01:00
parent 3678f235c0
commit 4fc350f637
1 changed files with 5 additions and 5 deletions
Download Patch File Download Diff File Expand all files Collapse all files

10
docs/docs/development.rst
View File

@@ -68,11 +68,11 @@ Evaluation of python code (evaluate.py)
API (api.py and api_classes.py)
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
The API has been designed to be as usable as possible. The documentation can be
found `here <plugin-api.html>`_. The API itself contains little code that needs
to be mentioned here. Generally I'm trying to be conservative with the API.
I'd rather not add new API features if they are not necessary, because it's
much harder to deprecate stuff than to add it later.
The API has been designed to be as usable as possible. The API documentation
can be found `here <plugin-api.html>`_. The API itself contains little code
that needs to be mentioned here. Generally I'm trying to be conservative with
the API. I'd rather not add new API features if they are not necessary,
because it's much harder to deprecate stuff than to add it later.