typo in backends documentation
Nobody has claimed this yet.
- Dominant language
- C++
- Stars
- 1.1k
- Forks
- 456
- Avg merge
- 1d 22h
- Merged PRs (30d)
- 165
Description
Required prerequisites
- Consult the security policy. If reporting a security vulnerability, do not report the bug using this form. Use the process described in the policy to report the issue.
- Make sure you've read the documentation. Your issue may be addressed there.
- Search the issue tracker to verify that this hasn't already been reported. +1 or comment there if it has.
- If possible, make a PR with a failing test to give us a starting point to work on!
Describe the bug
typos on https://nvidia.github.io/cuda-quantum/latest/using/backends/simulators.html
period should be a comma in the Note, and numbering should be consistent:
(1) The order of the option settings are interchangeable. For example, cudaq.set_target('nvidia', option='mgpu,fp64') is equivalent cudaq.set_target('nvidia', option='fp64.mgpu').
2. The nvidia target has
other typos:
"If you expect the a"
If no explicit target is set, i.e. if (missing comma)
Steps to reproduce the bug
read webpage
Expected behavior
no typos
Is this a regression? If it is, put the last known working version (or commit) here.
Not a regression
Environment
- CUDA Quantum version:
- Python version:
- C++ compiler:
- Operating system:
Suggestions
I'll submit a PR to fix this
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
Open the simulators documentation page at https://nvidia.github.io/cuda-quantum/latest/using/backends/simulators.html and review the Note and surrounding text for the reported punctuation, numbering, and wording errors. Done means correcting the listed typos and confirming the page reads consistently.
Written by the indexing model from the issue text.
Assessment
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 1/5
- Estimated time
- Under an hour
- Activity status
- Stale
- Clarity
- Clearly specified
- Newbie friendliness
- 65/100