NVIDIA / NVIDIA/cuda-quantum

Typos and style guide issues in Noisy Simulation and Hybrid Quantum Neural Networks tutorials

Open
#897 1 comment 0 reactions 1 assignee View on GitHub

@mmvandieren is already working on this.

Since Nov 13, 2023.

stale-notified
Dominant language
C++
Stars
1.1k
Forks
456
Avg merge
1d 22h
Merged PRs (30d)
165

Description

Required prerequisites
  • 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

According to the NVIDIA style guide we should be using American English spellings (-ize)

Noisy Simulation tutorial edits:

  • Paragraph 1:Characterize instead of characterise
  • Paragraph 3: Trace instead of trave in the first sentence
  • Paragraph 3: “The mathematical language used is of Kraus” reworded to “These maps are called Kraus operators…”
  • Paragraph 4: Is it bit flip channel or bit flip operation?
  • Paragraph 5: Let’s instead of lets
  • Cell block 6 second comment: Operators instead of Operator’s and representing instead of repsenting
  • Cell block 6 comment number 3: nparray instead of ndarray

Hybrid QNN tutorial edits:

  • Paragraph one: maximize
    Paragraph two: handwritten should be one word
    Cell block 4 comment: optimize
    Cell block 8: minimize in comments

@mmvandieren will create a fork and PR to make these changes

Steps to reproduce the bug

view webpages

Expected behavior

documentation consistent with NVIDIA style guide

Is this a regression? If it is, put the last known working version (or commit) here.

Not a regression

Environment
  • CUDA Quantum version: N/A
  • Python version:
  • C++ compiler:
  • Operating system:
Suggestions

No response

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.