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

API docs don't show init when class string is defined #5214

Closed
dabacon opened this issue Apr 7, 2022 · 2 comments
Closed

API docs don't show init when class string is defined #5214

dabacon opened this issue Apr 7, 2022 · 2 comments
Labels
kind/bug-report Something doesn't seem to work. kind/docs Documentation related problems, ideas, requests triage/discuss Needs decision / discussion, bring these up during Cirq Cynque

Comments

@dabacon
Copy link
Collaborator

dabacon commented Apr 7, 2022

Description of the issue

The API docs don't appear to show the doc string for the __init__ method when there is string supplied to the class string. The doc string for the __init__ method is often much more useful.

Here is an example:
https://quantumai.google/reference/python/cirq/ops/ResetChannel

@dabacon dabacon added the kind/bug-report Something doesn't seem to work. label Apr 7, 2022
@tanujkhattar
Copy link
Collaborator

xref #5151

@tanujkhattar tanujkhattar added kind/docs Documentation related problems, ideas, requests time/before-1.0 labels Apr 8, 2022
@MichaelBroughton MichaelBroughton added the triage/discuss Needs decision / discussion, bring these up during Cirq Cynque label Apr 20, 2022
@tanujkhattar
Copy link
Collaborator

tanujkhattar commented Apr 20, 2022

Docstring should go in class definition and not in init because init will not show up by default.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
kind/bug-report Something doesn't seem to work. kind/docs Documentation related problems, ideas, requests triage/discuss Needs decision / discussion, bring these up during Cirq Cynque
Projects
None yet
Development

No branches or pull requests

3 participants