Adds docstring for contrasts and some refactors#389
Merged
StephenNneji merged 9 commits intoApr 11, 2025
Merged
Conversation
StephenNneji
force-pushed
the
yet_another_docstring_branch
branch
from
6a6a8a3 to
741ec43
Compare
This was referenced Apr 9, 2025
DrPaulSharp
reviewed
Apr 9, 2025
Collaborator
DrPaulSharp
left a comment
DrPaulSharp
left a comment
There was a problem hiding this comment.
Looks good so far. Few things to address, in particular the docstrings for add/set contrast in numerous places.
| % | ||
| % project.addContrast('contrast 1', 'bulkIn', 'Silicon'); | ||
| obj.contrasts.addContrast(obj.getAllAllowedNames(), varargin{:}); | ||
| function obj = addContrast(obj, options) |
Collaborator
There was a problem hiding this comment.
It's all written down somewhere . . .
Collaborator
Author
There was a problem hiding this comment.
Don't understand what is written down somewhere? addContrast has always been in projectClass
Collaborator
There was a problem hiding this comment.
Sorry, I'd gone a bit mad by this point. I just mean that I've written the comments elsewhere, i.e., the same points as the other addContrast docstrings.
| % Allow setting of all parameters in terms of name value pairs. | ||
| % First input must be contrast number or name, subsequent | ||
| % inputs are name / value pairs for the parts involved | ||
| function obj = setContrast(obj, row, options) |
Collaborator
There was a problem hiding this comment.
deja vu all over again . . .
Collaborator
There was a problem hiding this comment.
Again, see previous setContrast docstring comments.
DrPaulSharp
approved these changes
Apr 10, 2025
StephenNneji
force-pushed
the
yet_another_docstring_branch
branch
from
a3e960a to
9276962
Compare
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.
No description provided.