Merged
Conversation
mathisrichter
approved these changes
Aug 24, 2022
Contributor
mathisrichter
left a comment
mathisrichter
left a comment
There was a problem hiding this comment.
Nice! Again, please consider removing the docstrings for trivial methods.
PhilippPlank
approved these changes
Aug 31, 2022
Contributor
PhilippPlank
left a comment
PhilippPlank
left a comment
There was a problem hiding this comment.
Looks good. One general remark. I would suggest that each docstring is a sentence which ends with a full stop - similar to our inline comment rules.
I added a comment where I found missing full stops/sentences.
monkin77
pushed a commit
to monkin77/thesis-lava
that referenced
this pull request
Jul 12, 2024
* formatted docstrings for automatic documentation
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
3 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.
Issue Number:
Objective of pull request:
This PR changes the format of several docstrings to allow shpinx to generate documentation.
Pull request checklist
Your PR fulfills the following requirements:
flakeheaven lint src/lava tests/) and (bandit -r src/lava/.) pass locallypytest) passes locallyPull request type
Please check your PR type:
What is the current behavior?
What is the new behavior?
Does this introduce a breaking change?
Supplemental information