Update documentation #16
Open
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
gsvgit
reviewed
Feb 13, 2025
| value : any | ||
| The value of the state | ||
|
|
||
| value: |
There was a problem hiding this comment.
Is it ok that type annotation is missing?
|
|
||
| Parameters | ||
| ---------- | ||
| value: |
There was a problem hiding this comment.
Is it ok that type annotation is missing?
| boxes : set of :class:`~pyformlang.rsa.Box` | ||
| A finite set of boxes | ||
|
|
||
| start_box: |
There was a problem hiding this comment.
Is it ok that type annotation is missing?
| start_nonterminal : :class:`~pyformlang.finite_automaton.Symbol` | str | ||
| The start nonterminal for the recursive automaton | ||
| ---------- | ||
| regex: |
There was a problem hiding this comment.
Is it ok that type annotation is missing?
| start_nonterminal : \ | ||
| :class:`~pyformlang.finite_automaton.Symbol` | str, optional | ||
| The start nonterminal, S by default | ||
| text: |
There was a problem hiding this comment.
Is it ok that type annotation is missing?
|
|
||
| Parameters | ||
| ----------- | ||
| value : any | ||
| The value of the object | ||
| value: |
| :param l_sets: a list containing tuples (C, M) where: | ||
|
|
||
| Parameters | ||
| ---------- |
| prod : any | ||
| The production used in the rule | ||
| ---------- | ||
| left: |
| prod : any | ||
| The production used in the rule | ||
| ---------- | ||
| left: |
| rules : iterable of :class:`~pyformlang.indexed_grammar.ReducedRule` | ||
| A list of all the rules | ||
| optim : int | ||
| rules: |
gsvgit
approved these changes
Feb 16, 2025
bygu4
force-pushed
the
rework_indexed_grammars
branch
from
1dddebb to
e63bd9d
Compare
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Configure Ruff linter for applying pycodestyle, pydocstyle and other's rules. Update the documentation after adding type annotations to pyformlang.
Notes
It is important to note that sphinx with napoleon supports Python type annotations, so adding type hints to docstrings is not necessary.
Todo
Related