minor errors and ambiguities in docs
Nobody has claimed this yet.
- Dominant language
- C++
- Stars
- 1.1k
- Forks
- 455
- Avg merge
- 1d 22h
- Merged PRs (30d)
- 165
Description
CPU should be GPU on the note in documentation before the Run section: https://nvidia.github.io/cuda-quantum/latest/using/basics/run_kernel.html
kernel(thetas) syntax is used twice on the docs page: https://nvidia.github.io/cuda-quantum/latest/using/examples/building_kernels.html
this syntax doesn't initiate an error, but also doesn't do anything. So I'm not sure we should be giving this as an example in the docs
Fixed with PR #3383
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 two linked documentation pages: the note before the Run section in run_kernel.html and the examples in building_kernels.html. Confirm the CPU/GPU wording and decide how the two kernel(thetas) examples should be handled; completion is reflected by the fix already described in PR #3383.
Written by the indexing model from the issue text.
Assessment
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 25/100