Uh oh!
There was an error while loading. Please reload this page.
Adds docstrings to controls and project fields - #117
Conversation
DrPaulSharp
left a comment
There was a problem hiding this comment.
All looks good, please review the descriptions I've commented on.
Also, what do you want to do regarding docstrings for the models - descriptions of the fields are already present of course, do you want to put them in this format?
Uh oh!
There was an error while loading. Please reload this page.
Uh oh!
There was an error while loading. Please reload this page.
Uh oh!
There was an error while loading. Please reload this page.
Uh oh!
There was an error while loading. Please reload this page.
Uh oh!
There was an error while loading. Please reload this page.
Uh oh!
There was an error while loading. Please reload this page.
Uh oh!
There was an error while loading. Please reload this page.
Uh oh!
There was an error while loading. Please reload this page.
This PR fixes the remainder of #5 by adding descriptions to all of the fields in
ProjectandControls.This format uses field docstrings which are loaded into thedescriptionmodel field attribute , meaning they can be picked up both by autodoc-pydantic for the documentation and can also be used in the GUI (e.g. for mouseover help text).