mirror of
https://github.com/davidhalter/jedi.git
synced 2025-12-21 13:01:14 +08:00
45 lines
777 B
ReStructuredText
45 lines
777 B
ReStructuredText
.. include:: ../global.rst
|
|
|
|
Recipes
|
|
=======
|
|
|
|
Here are some tips on how to use |jedi| efficiently.
|
|
|
|
|
|
.. _type-hinting:
|
|
|
|
Type Hinting
|
|
------------
|
|
|
|
If |jedi| cannot detect the type of a function argument correctly (due to the
|
|
dynamic nature of Python), you can help it by hinting the type using
|
|
Sphinx-style info field lists or Epydoc docstrings.
|
|
|
|
**Sphinx style**
|
|
|
|
http://sphinx-doc.org/domains.html#info-field-lists
|
|
|
|
::
|
|
|
|
def myfunction(node):
|
|
"""Do something with a ``node``.
|
|
|
|
:type node: ProgramNode
|
|
|
|
"""
|
|
node.| # complete here
|
|
|
|
**Epydoc**
|
|
|
|
http://epydoc.sourceforge.net/manual-fields.html
|
|
|
|
::
|
|
|
|
def myfunction(node):
|
|
"""Do something with a ``node``.
|
|
|
|
@param node: ProgramNode
|
|
|
|
"""
|
|
node.| # complete here
|