Quantum icon indicating copy to clipboard operation
Quantum copied to clipboard

Improve consistency of code style, terminology

Open cgranade opened this issue 4 years ago • 1 comments

Describe the bug Some of the samples are inconsistent with respect to Q# coding style and terminology, such that consolidating on these would help to reduce user confusion and make for a more coherent experience for learning Q#.

E.g.:

  • Consistent use of terminology (ancilla vs auxiliary, iterative PE versus quantum PE)
  • API documentation issues (short summaries, with longer details and mathematical content in descriptions)
  • Use of verbs described in API design principles to denote operations.
  • Code style conventions (num vs n vs idx, extraneous parens on if statements, etc.)

cgranade avatar May 29 '21 02:05 cgranade

could i work on this issue?

unnati914 avatar Aug 18 '21 09:08 unnati914