add recipes also to features & caveats

This commit is contained in:
David Halter
2013-08-31 18:15:21 +04:30
parent 7d97d70dc1
commit 39e766c2eb
2 changed files with 43 additions and 44 deletions

View File

@@ -98,6 +98,49 @@ might be dangerous. But if it does you're screwed anyways, because eventualy
you're going to execute your code, which executes the import. you're going to execute your code, which executes the import.
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
A little history A little history
---------------- ----------------

View File

@@ -1,44 +0,0 @@
.. 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