Add docs for MaybeSentinel and RemovalSentinel #15
Conversation
facebook-github-bot
added
the
CLA Signed
These were referred to by other parts of the documentation, and they provide core parts of our functionality, so we should have explicit documentation for them.
| >>> new_fn_call = fn_call.with_changes( | ||
| ... args=[*fn_call.args, cst.Arg(cst.Integer("3"))] | ||
| ... ) | ||
| >>> dummy_module = cst.parse_module("") # we need to use Module.code_for_node |
There was a problem hiding this comment.
Shall we provide some helper to render code of a Node (not Module) easily?
What's the reason we don't provide the code property in Node or Statement?
There was a problem hiding this comment.
We can only generate code in the context of a module because the module contains information about the default indentation level, newline, etc.
However (as this example demonstrates) it'd be useful to have a .code property on every node for debugging purposes. I just don't know how we can communicate these pitfalls to the developer.
It's also a little weird that parse_expression and parse_statement are lossy and not entirely reversible, but that's by design. If you have a module using \r\n as it's newline format and you use parse_statement to insert a line of code with \n in it, I'd want that \n to be replaced with \r\n (which is the current behavior).
Summary
These were referred to by other parts of the documentation, and provide
core parts of our functionality, so we should have explicit
documentation for them.
Test Plan
https://1371-200896124-gh.circle-artifacts.com/0/doc/nodes.html#maybe-sentinel
https://1371-200896124-gh.circle-artifacts.com/0/doc/visitors.html#libcst.RemovalSentinel