Skip to content

Docs|Tutorials: Inconsistent reference style #5253

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
TimoEckstein opened this issue Apr 12, 2022 · 2 comments
Open

Docs|Tutorials: Inconsistent reference style #5253

TimoEckstein opened this issue Apr 12, 2022 · 2 comments
Labels
area/docs area/tutorials kind/health For CI/testing/release process/refactoring/technical debt items

Comments

@TimoEckstein
Copy link
Contributor

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 #5151

@TimoEckstein TimoEckstein added the kind/health For CI/testing/release process/refactoring/technical debt items label Apr 12, 2022
@dabacon
Copy link
Collaborator

dabacon commented Apr 20, 2022

See #5220 for how we should format external links

@tanujkhattar
Copy link
Collaborator

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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area/docs area/tutorials kind/health For CI/testing/release process/refactoring/technical debt items
Projects
Status: No status
Development

No branches or pull requests

8 participants