mirror of
https://github.com/Instagram/LibCST.git
synced 2025-12-23 10:35:53 +00:00
9d68a58c17
I discussed the high-level idea here with @DragonMinded a few months ago, but this isn't set in stone. If people have better ideas for names, I'd love to hear it. Publicly-Visible Changes ------------------------ - SyntacticPositionProvider is deprecated. The new name is PositionProvider. - BasicPositionProvider is deprecated. The new name is WhitespaceInclusivePositionProvider. - Documentation is updated to better explain these renamed providers and how to use them. The prefixes "Syntactic" and "Basic" were pretty bad because they're just concepts that we made up for LibCST. The idea for the new names is that most users will want the SyntacticPositionProvider, and so we should name things so that the user will naturally gravitate towards the correct choice. There's some argument that we shouldn't even bother exposing WhitespaceInclusivePositionProvider, but we already need to implement it as a fallback for PositionProvider, and it might be useful for some niche use-cases. Once we have another major version bump, we can remove the old class names. The old class names have already be removed from the documentation so that new users aren't tempted to use them. Internal-Only Changes --------------------- - `PositionProvider` is now `_PositionProviderUnion`. This type alias was never a public API (and probably never will be). - `BasicCodegenState` is now `WhitespaceInclusivePositionProvidingCodegenState`. - `SyntacticCodegenState` is now `PositionProvidingCodegenState`. |
||
|---|---|---|
| .. | ||
| _static | ||
| _templates | ||
| conf.py | ||
| index.rst | ||
| matchers.rst | ||
| matchers_tutorial.ipynb | ||
| metadata.rst | ||
| metadata_tutorial.ipynb | ||
| motivation.rst | ||
| nodes.rst | ||
| parser.rst | ||
| scope_tutorial.ipynb | ||
| tutorial.ipynb | ||
| visitors.rst | ||
| why_libcst.rst | ||