Skip to content

Use lowercase_with_underscore.rst naming convention for doc files #238

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

Closed
Tracked by #143
bobleesj opened this issue Dec 15, 2024 · 2 comments · Fixed by #246
Closed
Tracked by #143

Use lowercase_with_underscore.rst naming convention for doc files #238

bobleesj opened this issue Dec 15, 2024 · 2 comments · Fixed by #246
Assignees

Comments

@bobleesj
Copy link
Contributor

bobleesj commented Dec 15, 2024

Creating an issue for now:


@sbillinge Do we want to use lower_with_underscore for doc .rst files? A bit hard to read diffractionobjectsexample.rst. Not sure about the convention. Did a quick search and appears NumPy is using the lower_with_underscore convention (mostly, not all) https://github.com/numpy/numpy/tree/main/doc/source/reference

@bobleesj @yucongalicechen yes, let's use this convention. But I don't worry too much for now, I will just merge this.

Originally posted by @sbillinge in #237 (comment)

@yucongalicechen
Copy link
Contributor

I can take this issue! It's just changing the file names, right? @bobleesj

@yucongalicechen yucongalicechen self-assigned this Dec 17, 2024
@bobleesj
Copy link
Contributor Author

Yup @yucongalicechen!

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 a pull request may close this issue.

2 participants