-
Notifications
You must be signed in to change notification settings - Fork 24
Closed
Labels
simplificationunifying, shortening, and cleaning tasks that make the modules and user interface more cohesiveunifying, shortening, and cleaning tasks that make the modules and user interface more cohesive
Milestone
Description
Right now each parameter to a function is documented with a description on one line, its type on the next line, and a newline before the next one. It's possible to do these in one line in a way Sphinx will understand, which keeps the user from needing to scroll as much while examining the source code. As I go through the code, I'm trying to adopt more of a numpy style. I'll have to look at the CI to figure out how the docs are getting built and make sure I'm not breaking anything.
As I add parameters to functions, I'm having to change docstrings anyway, so this is a natural thing to touch.
Reactions are currently unavailable
Metadata
Metadata
Assignees
Labels
simplificationunifying, shortening, and cleaning tasks that make the modules and user interface more cohesiveunifying, shortening, and cleaning tasks that make the modules and user interface more cohesive