Skip to content
This repository has been archived by the owner on Jan 12, 2024. It is now read-only.

Improve consistency of code style, terminology #504

Open
cgranade opened this issue May 29, 2021 · 1 comment
Open

Improve consistency of code style, terminology #504

cgranade opened this issue May 29, 2021 · 1 comment
Labels

Comments

@cgranade
Copy link
Contributor

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.)
@unnati914
Copy link

could i work on this issue?

Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
Projects
None yet
Development

No branches or pull requests

2 participants