doc: reformat geckomat function help to NumPy-style docstrings#415
Merged
Conversation
Convert the leading help comment of every function under src/geckomat to NumPy-style docstrings (Parameters/Returns/Notes/Examples/See also). This renders as structured API tables in the mkdocstrings/Read the Docs site while staying clean, idiomatic MATLAB help text. Only comment blocks were changed; no code was modified.
edkerk
changed the title
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
1 participant
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.
Main improvements in this PR:
Instructions on merging this PR:
develop4as target branch, and will be resolved with a squash-merge.mainas target branch, and will be resolved with a merge commit.