quantumlib / Cirq

A Python framework for creating, editing, and invoking Noisy Intermediate Scale Quantum (NISQ) circuits.
Apache License 2.0
4.23k stars 1.01k forks source link

Docs|Tutorials: Inconsistent reference style #5253

Open TimoEckstein opened 2 years ago

TimoEckstein commented 2 years ago

Description of the issue In the Cirq tutorials there is a variety of reference styles. Making these consistent would probably not only make a slightly better impression to the reader, but also would help them to identify references faster; in particularly if the references were placed consistently at the end of each file/page.

Examples of the current reference style variety:

Suggestion to resolve the issue Use journal-inspired consistent references and put them at the end of each file into a reference block, similar to:

Cirq version cirq.master

xref https://github.com/quantumlib/Cirq/issues/5151

dabacon commented 2 years ago

See #5220 for how we should format external links

tanujkhattar commented 2 years ago

Google Developer style guide: https://developers.google.com/style