Protocol documentation are missing methods #2953
Labels
area/docs
area/docstrings
area/protocols
area/site
triage/accepted
A consensus emerged that this bug report, feature request, or other action should be worked on
Comments
balopat
added
kind/docs
triage/accepted
|
This issue was opened for sphinx - but this is actually still an issue for devsite as well |
CirqBot
pushed a commit
that referenced
this issue
Oct 23, 2020
Fixes #2953. Also adds a preview Dockerfile that is a seed for a potential preview service that could run as a GithubAction, deploy an ephemeral Cloud Run container to preview the generated docs and comment on the PR with the link. An example link for this particular change is: https://api-docs-fijpqdu4wa-uc.a.run.app/ While the preview is not "the real thing" - a fullblown devsite preview is not realistic at this point. This preview gives an indication about the intermediate markdown representation generated by tf-docs markdown generator. It's good for: - latex checking in docstrings - e.g. https://api-docs-fijpqdu4wa-uc.a.run.app/cirq/experiments/two_qubit_state_tomography.md - checking whether the private methods really show up: https://api-docs-fijpqdu4wa-uc.a.run.app/cirq/protocols/SupportsActOn.md
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Likely because they are private!
It looks like a workaround might be to include
in the docstring
The text was updated successfully, but these errors were encountered: