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

Capture docs from abstract base classes? #980

Closed
fdmalone opened this issue May 21, 2024 · 2 comments
Closed

Capture docs from abstract base classes? #980

fdmalone opened this issue May 21, 2024 · 2 comments
Labels
docs Improvements or additions to documentation

Comments

@fdmalone
Copy link
Collaborator

fdmalone commented May 21, 2024 •
edited
Loading

SelectOracle / PrepareOracle / BlockEncoding / ... potentially more bloqs have docs which aren't captured anywhere which could be helpful for developers. Should they be captured?
@fdmalone fdmalone added the docs Improvements or additions to documentation label May 21, 2024
@mpharrigan
Copy link
Collaborator

Have you tried adding a BloqDocSpec without any bloq examples? it will pull in / render the docstrings which I assume is the extent of the documentation you were imagining

@mpharrigan mpharrigan mentioned this issue May 22, 2024
Merged
@fdmalone
Copy link
Collaborator Author

This already worked as per #988 and #967

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
docs Improvements or additions to documentation
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
2 participants
@mpharrigan @fdmalone