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.

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

Fix zbs and DecoderManager docstrings #470

Merged
merged 9 commits into from
Nov 5, 2023
Merged

Conversation

lekcyjna123
Copy link
Contributor

Sphinx raised a warning about zbs unit docstrings and the docs were generated wrongly. Additionally docstrings for DecoderManager were miss placed, so they weren't included in API output.

This commit fix both issues.

coreblocks/fu/fu_decoder.py Outdated Show resolved Hide resolved
@tilk tilk added the documentation Improvements or additions to documentation label Oct 7, 2023
Copy link
Member

@JumiDeluxe JumiDeluxe left a comment

Choose a reason for hiding this comment

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

Builds for me.
Just missing Fn: Type[IntFlag] in generated Sphinx documentation, with suggested changes everything is OK

coreblocks/fu/fu_decoder.py Show resolved Hide resolved
@tilk tilk merged commit d0ebfc0 into master Nov 5, 2023
6 checks passed
@tilk tilk deleted the lekcyjna/fix-zbs-docstring branch November 5, 2023 20:29
github-actions bot pushed a commit that referenced this pull request Nov 5, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants