VimPlug/parso
1
0
Fork 0
mirror of https://github.com/davidhalter/parso.git synced 2025-12-31 00:24:41 +08:00
Code Issues Actions Packages Projects Releases Wiki Activity

More docstrings.

Browse Source
This commit is contained in:
Dave Halter
2017-09-03 18:36:03 +02:00
parent 60ed141d80
commit 73c61bca4a
3 changed files with 23 additions and 9 deletions
Download Patch File Download Diff File Expand all files Collapse all files

13
docs/docs/usage.rst
View File

@@ -4,8 +4,8 @@ Usage
=====
|parso| works around grammars. You can simply create Python grammars by calling
``load_grammar``. Grammars (with a custom tokenizer and custom parser trees)
can also be created by directly instantiating ``Grammar``. More information
:py:func:`parso.load_grammar`. Grammars (with a custom tokenizer and custom parser trees)
can also be created by directly instantiating :py:func:`parso.Grammar`. More information
about the resulting objects can be found in the :ref:`parser tree documentation
<parser-tree>`.
@@ -18,14 +18,21 @@ The simplest way of using parso is without even loading a grammar
>>> parso.parse('foo + bar')
<Module: @1-1>
Loading a Grammar
-----------------
Typically if you want to work with one specific Python version, use:
.. autofunction:: parso.load_grammar
Grammar methods
---------------
You will get back a grammar object that you can use to parse code and find
issues in it:
.. autoclass:: parso.grammar.Grammar
.. autoclass:: parso.Grammar
:members:
:undoc-members: