Skip to content
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

docs: Double-check and refine docstrings before 3.6.0 release #239

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

docs: Double-check and refine docstrings before 3.6.0 release #239

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

Comments

@bobleesj
Copy link
Contributor

  • Use consistent NumPy docstrings style
  • Ensure API docs remain clear for new maintainers and users with limited programming experience.

          maybe we could further refine docstrings in separate issues? @sbillinge

Originally posted by @bobleesj in #228 (comment)

@sbillinge
Copy link
Contributor

would this be a good kind of group hackathon? everyone take a few? Also a learning/teaching experience?

@bobleesj
Copy link
Contributor Author

Yeah, early next week would be best. I will shift my gears for crystallography for the next 3 days..

I can lead a quick rundown of our group's testing standards and assign members to improve docstrings collaboratively during a call.

@bobleesj bobleesj self-assigned this Dec 16, 2024
@bobleesj bobleesj added this to the 3.6.0 release milestone Dec 16, 2024
@bobleesj bobleesj changed the title Double-check and refine docstrings before 3.6.0 release docs: Double-check and refine docstrings before 3.6.0 release Dec 28, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
2 participants