diff --git a/docs/docs/features.rst b/docs/docs/features.rst index 700fccd3..b50619ba 100644 --- a/docs/docs/features.rst +++ b/docs/docs/features.rst @@ -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. +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 ---------------- diff --git a/docs/docs/recipes.rst b/docs/docs/recipes.rst deleted file mode 100644 index 63ff1d0a..00000000 --- a/docs/docs/recipes.rst +++ /dev/null @@ -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