More documentation problems
Maintainers usually reply within 1 day
Nobody has claimed this yet.
Assessment
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Newbie friendliness
- 48/100
- Issue type
- Bug
- Clarity
- Mostly clear
- Activity status
- Stale
- Tech stack
- python
- Domain
- documentation
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.
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.
- Dominant language
- Python
- Stars
- 2.2k
- Forks
- 674
- Avg merge
- 1d 14h
- Merged PRs (30d)
- 5
Getting set up
- No Dockerfile or Docker Compose file
- No pull request template
- Read the contributing 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.
More from tensorflow/quantum
-
area/c++ area/core kind/bug-report
Difficulty 2/5 1-3 hours Newbie friendliness 78/100
tensorflow/quantum#1140 ·
Maintainers usually reply within 1 day
-
Avoid hard-coding "quantum" in `scripts/` scriptsPossibly taken @openbotgit claimed this 23 days ago. Openarea/devops help wanted no QC knowledge needed priority/before-0.7.7
Difficulty 2/5 1-3 hours Newbie friendliness 68/100
tensorflow/quantum#1082 · 2 comments · 1 reaction ·
Maintainers usually reply within 1 day
-
area/c++ area/core kind/bug-report
Difficulty 3/5 1-2 days Newbie friendliness 74/100
tensorflow/quantum#1141 ·
Maintainers usually reply within 1 day
-
Bug (likely typo) in `core/serialize/serializer_test.py`Possibly taken @mhucka claimed this 15 days ago. Openarea/serialization area/tests
tensorflow/quantum#1129 · 1 assignee ·
Maintainers usually reply within 1 day
-
Support Keras 3May be free again @rosspeili claimed this 118 days ago, and no pull request is open. Openarea/keras help wanted skill-level/intermediate
tensorflow/quantum#1090 · 5 comments · 1 assignee ·
Maintainers usually reply within 1 day
All issues in tensorflow/quantum
Similar issues
-
release
Difficulty 2/5 1-3 hours Newbie friendliness 76/100
MichaelYcJo/SpecSeal#1535 ·
-
bug
Difficulty 2/5 1-3 hours Newbie friendliness 82/100
valentinfrlch/ha-llmvision#769 ·
Maintainers usually reply within 1 day
-
bug
Difficulty 1/5 Under an hour Newbie friendliness 75/100
daniel-ospina/tortoise#11937 · 1 comment ·
Maintainers usually reply within 1 day
-
good first issue help wanted python up-for-grabs
Difficulty 2/5 1-3 hours Newbie friendliness 82/100
andrewsiah/agentswarm-data-tasks#238 ·
Maintainers usually reply within 1 day
-
Difficulty 2/5 1-3 hours Newbie friendliness 70/100
cadence-workflow/cadence-ai-samples#175 ·
Maintainers usually reply within 1 day