-
Notifications
You must be signed in to change notification settings - Fork 390
docs: add API and naming #731
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Conversation
scop
commented
Apr 11, 2022
- Public interface and backward compatibility #537
- Customizability and naming conventions for each completion #539
We overflow in api-and-naming.md's table, and there's no option to disable this check (yet?) in PyMarkdown 0.9.6. https://github.com/jackdewinter/pymarkdown/blob/9e4813ba4ba9923330f4682e925cf3149848ccf4/docs/rules/rule_md013.md
I think the descriptions of the existing rules are fine. In addition, I have questions about the naming rules for the following cases (I have created separate threads in #539):
|
Exporter functions must avoid conflicts between the passed variable names and their internal local variables. Differentiate using an underscore. #539 (comment)
I'm not sure if I correctly get your intent, but I added a commit 4f6e424 that describes the rule of I also suggest using the word "private" instead of "internal" for the symmetry with "public" in the counterpart (see commit 5435b7c), though I am not sure if you like it. If not, we can drop this commit any time. |
Thanks for checking! |
I wonder if we have some unfinished business here still, or should we proceed to merge? |
I think we can merge it. Maybe there would be something to adjust after the refactoring, but I think that can be always processed in another PR. By the way, I think it is good to include links to these documents in CONTRIBUTING.md |
Link to CONTRIBUTING.md added, cheers. |
Thanks! |