Request: docstrings and Sphinx documentation? about jedi HOT 6 CLOSED

I try to improve the docstrings, they are really bad in some places. Sphinx... Not now. I had it running once, but if the docstrings are not good enough, it doesn't make sense. But later on.

from jedi.

Is this enough? Please tell me if you don't understand the api. Sphinx is not going to come for quite some time (if ever). At the earliest I'll expect it in January.

from jedi.

Thanks, that is useful. (Especially "don't use" lines.)

In the future, I think it would be great to have executable examples (i.e., doctests), like this:

>>> import os
>>> source = """\
... import json
... json.l"""
>>> script = Script(source, 2, 6, os.devnull)
>>> script
<jedi.api.Script at 0x7f6d40f3db90>
>>> completions = script.complete()
>>> completions
[<Completion: load>, <Completion: loads>]
>>> completions[0].complete
'oads'
>>> completions[0].word
'loads'

from jedi.

What do you think: Do they belong into the header doctests or everywhere? (Because really everything depends on each other)

from jedi.

I agree that's difficult part. I would put the above test in Completion class docstring.

from jedi.

https://jedi.readthedocs.org/en/latest/

This should fix it.

from jedi.