beast icon indicating copy to clipboard operation
beast copied to clipboard

Fix docstrings throughout code

Open karllark opened this issue 8 years ago • 2 comments

The docstrings are not all correctly formatted. Need to systematically go through the code and fix them. And add/expand them where needed.

Especially useful in:

  • [ ] physicsmodel
  • [ ] observationmodel
  • [x] fitting

karllark avatar Feb 27 '17 22:02 karllark

Is there a more specific location where the docstrings need attention or are they throughout the code? Happy to give it a try, and expand them for code I am familar with.

petiay avatar Jul 16 '19 18:07 petiay

Nope. Just all throughout the code. You could focus on the code that is covered with the CI tests (use the coverage button on the main page). That would avoid updating docstrings that have a high probability of being deleted due to never being used.

karllark avatar Jul 16 '19 19:07 karllark