|
108 | 108 | This function will display planning tips, usage guidelines, |
109 | 109 | and testing and error-handling strategies. |
110 | 110 |
|
| 111 | +A command-line interface is also available, using: |
| 112 | +
|
| 113 | + python -m pyparsing.ai.show_best_practices |
| 114 | +
|
111 | 115 | Guidance to emphasize: |
112 | 116 | - Before developing the pyparsing expressions, define a Backus-Naur Form definition and save this in docs/grammar.md. Update this document as changes are made in the parser. |
113 | 117 | - Use PEP8 method and argument names in the pyparsing API ("parse_string", not "parseString") |
|
121 | 125 | - Use objects defined in pyparsing.common for common types like integer, real - these already have their conversion parse actions defined |
122 | 126 | - Use the pyparsing ParserElement.run_tests method to run mini validation tests |
123 | 127 |
|
124 | | -NOTE: `show_best_practices()` loads theofficial guidelines from |
125 | | -a Markdown filebundled with the package. |
| 128 | +NOTE: `show_best_practices()` loads thecomplete guidelines from a Markdown file |
| 129 | +bundled with the package. |
126 | 130 | """ |
127 | 131 | # fmt: on |
128 | 132 | fromtypingimportNamedTuple |
|