Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Doc/auto api #318

Merged
merged 8 commits into from
Aug 31, 2022
Merged

Doc/auto api #318

merged 8 commits into from
Aug 31, 2022

Conversation

weidel-p
Copy link
Contributor

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:

  • Issue created that explains the change and why it's needed
  • Tests are part of the PR (for bug fixes / features)
  • Docs reviewed and added / updated if needed (for bug fixes / features)
  • PR conforms to Coding Conventions
  • PR applys BSD 3-clause or LGPL2.1+ Licenses to all code files
  • Lint (flakeheaven lint src/lava tests/) and (bandit -r src/lava/.) pass locally
  • Build tests (pytest) passes locally

Pull request type

Please check your PR type:

  • Bugfix
  • Feature
  • Code style update (formatting, renaming)
  • Refactoring (no functional changes, no api changes)
  • Build related changes
  • Documentation changes
  • Other (please describe):

What is the current behavior?

What is the new behavior?

Does this introduce a breaking change?

  • Yes
  • No

Supplemental information

mathisrichter
mathisrichter approved these changes Aug 24, 2022
View reviewed changes
Copy link
Contributor

@mathisrichter mathisrichter left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nice! Again, please consider removing the docstrings for trivial methods.

src/lava/magma/core/decorator.py Outdated Show resolved Hide resolved
src/lava/magma/core/decorator.py Outdated Show resolved Hide resolved
src/lava/magma/core/decorator.py Outdated Show resolved Hide resolved
src/lava/magma/core/process/process.py Show resolved Hide resolved
src/lava/magma/core/run_configs.py Show resolved Hide resolved
src/lava/magma/core/sync/protocol.py Outdated Show resolved Hide resolved
src/lava/proc/sdn/process.py Show resolved Hide resolved
@weidel-p weidel-p mentioned this pull request Aug 30, 2022
Merged
PhilippPlank
PhilippPlank approved these changes Aug 31, 2022
View reviewed changes
Copy link
Contributor

@PhilippPlank PhilippPlank left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

src/lava/magma/core/process/variable.py Outdated Show resolved Hide resolved
src/lava/magma/core/sync/protocols/loihi_protocol.py Outdated Show resolved Hide resolved
src/lava/magma/runtime/message_infrastructure/multiprocessing.py Outdated Show resolved Hide resolved
src/lava/magma/runtime/message_infrastructure/nx.py Show resolved Hide resolved
src/lava/magma/runtime/message_infrastructure/nx.py Show resolved Hide resolved
src/lava/proc/sdn/process.py Outdated Show resolved Hide resolved
src/lava/proc/sdn/process.py Outdated Show resolved Hide resolved
src/lava/proc/sdn/process.py Outdated Show resolved Hide resolved
src/lava/magma/compiler/builders/interfaces.py Show resolved Hide resolved
@PhilippPlank PhilippPlank added the documentation Improvements or additions to documentation label Aug 31, 2022
@weidel-p weidel-p merged commit 780ee5a into main Aug 31, 2022
monkin77 pushed a commit to monkin77/thesis-lava that referenced this pull request Jul 12, 2024
@weidel-p
Doc/auto api (lava-nc#318)
edf4f84 
* formatted docstrings for automatic documentation
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@PhilippPlank PhilippPlank PhilippPlank approved these changes

@mathisrichter mathisrichter mathisrichter approved these changes

Assignees

@weidel-p weidel-p

Labels
documentation Improvements or additions to documentation
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@weidel-p @mathisrichter @PhilippPlank