tensorflow / tensorflow/quantum
More documentation problems
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 2.2k
- Forks
- 665
- PR merge metrics
- No merged PRs in 30d
Description
While there are still problems with the rendering of the new math ops (see https://github.com/tensorflow/quantum/issues/594), I found what I think is another documentation problem on the tfq website. The descriptions for the attributes of tfq.datasets.spin_system.SpinSystemInfo (https://www.tensorflow.org/quantum/api_docs/python/tfq/datasets/spin_system/SpinSystemInfo) are all missing. This is the only place on the tfq website where the little description boxes have labels but no descriptions (see the attached picture to if this explanation is not clear).
Additionally, since the attribute descriptions exist in the code (see https://github.com/tensorflow/quantum/blob/v0.5.1/tensorflow_quantum/datasets/spin_system.py#L25) I assume this is a bug.
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start with the SpinSystemInfo API documentation page and compare its missing attribute descriptions with the definitions in tensorflow_quantum/datasets/spin_system.py at v0.5.1. Trace how that source is converted into the TensorFlow Quantum website documentation, then verify that all attribute descriptions render in the generated page.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- documentation
- Issue type
- Bug
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 48/100