Adds docstrings to controls and project fields#117
Merged
alexhroom merged 4 commits intoRascalSoftware:mainfrom Jan 22, 2025
alexhroom:controls-project-docstrings
Merged
Adds docstrings to controls and project fields#117alexhroom merged 4 commits intoRascalSoftware:mainfrom alexhroom:controls-project-docstrings
alexhroom merged 4 commits intoRascalSoftware:mainfrom
alexhroom:controls-project-docstrings
Conversation
DrPaulSharp
approved these changes
Jan 20, 2025
Collaborator
DrPaulSharp
left a comment
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?
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
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).