ruff/crates/ruff_python_parser/src
Dhruv Manilawala 04a922866a
Add basic docs for the parser crate (#11199)
## Summary

This PR adds a basic README for the `ruff_python_parser` crate and
updates the CONTRIBUTING docs with the fuzzer and benchmark section.

Additionally, it also updates some inline documentation within the
parser crate and splits the `parse_program` function into
`parse_single_expression` and `parse_module` which will be called by
matching against the `Mode`.

This PR doesn't go into too much internal detail around the parser logic
due to the following reasons:
1. Where should the docs go? Should it be as a module docs in `lib.rs`
or in README?
2. The parser is still evolving and could include a lot of refactors
with the future work (feedback loop and improved error recovery and
resilience)

---------

Co-authored-by: Alex Waygood <Alex.Waygood@Gmail.com>
2024-04-29 17:08:07 +00:00
..
lexer Simplify formatting of strings by using flags from the AST nodes (#10489) 2024-03-20 16:16:54 +00:00
parser Add basic docs for the parser crate (#11199) 2024-04-29 17:08:07 +00:00
snapshots Replace LALRPOP parser with hand-written parser (#10036) 2024-04-18 17:57:39 +05:30
error.rs Replace LALRPOP parser with hand-written parser (#10036) 2024-04-18 17:57:39 +05:30
lexer.rs Remove unused lexical error types (#11145) 2024-04-25 15:24:16 +00:00
lib.rs Add basic docs for the parser crate (#11199) 2024-04-29 17:08:07 +00:00
soft_keywords.rs Replace LALRPOP parser with hand-written parser (#10036) 2024-04-18 17:57:39 +05:30
string.rs Replace LALRPOP parser with hand-written parser (#10036) 2024-04-18 17:57:39 +05:30
token.rs Add basic docs for the parser crate (#11199) 2024-04-29 17:08:07 +00:00
token_set.rs Replace LALRPOP parser with hand-written parser (#10036) 2024-04-18 17:57:39 +05:30
token_source.rs Replace LALRPOP parser with hand-written parser (#10036) 2024-04-18 17:57:39 +05:30
typing.rs Add basic docs for the parser crate (#11199) 2024-04-29 17:08:07 +00:00