Skip to content

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

Merged
merged 11 commits into from
Dec 6, 2022
Merged

docs: add API and naming #731

merged 11 commits into from
Dec 6, 2022

Conversation

@akinomyoga
Copy link
Collaborator

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):

  • More flexible positions of double underscores in the names? -> #539 (thread)
  • Naming of local variables in the function that exports variables of dynamic names? -> #539 (thread)

@akinomyoga
Copy link
Collaborator

#539 (reply in thread)

I think we have a conclusion here and in #791. Could you document the convention in #731? TIA :)

I'm not sure if I correctly get your intent, but I added a commit 4f6e424 that describes the rule of _mut_.

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.

@scop
Copy link
Owner Author

scop commented Sep 10, 2022

Both 4f6e424 and 5435b7c look good to me, thanks!

@akinomyoga
Copy link
Collaborator

Thanks for checking!

@scop
Copy link
Owner Author

scop commented Dec 6, 2022

I wonder if we have some unfinished business here still, or should we proceed to merge?

@akinomyoga
Copy link
Collaborator

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

@scop scop merged commit 1178359 into master Dec 6, 2022
@scop scop deleted the docs/api-and-naming branch December 6, 2022 19:53
@scop
Copy link
Owner Author

scop commented Dec 6, 2022

Link to CONTRIBUTING.md added, cheers.

@akinomyoga
Copy link
Collaborator

Thanks!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants