Skip to content

Commit dbbca73

Browse files
authored
Change master to main in documentation (#6365)
- We are changing the default branch from master to main in order to conform to best practices and remove problematic terminology. - This PR changes references in documentation (mostly links) to use main.
1 parent ced1383 commit dbbca73

File tree

74 files changed

+215
-215
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

74 files changed

+215
-215
lines changed

CONTRIBUTING.md

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -38,27 +38,27 @@ Forking creates a new github repo at the location
3838
your github id. Use the directions on the
3939
[development page](docs/dev/development.md) to download a copy to
4040
your local machine. You need only do this once.
41-
1. Checkout master and create a new branch from this master
41+
1. Checkout main and create a new branch from this main
4242
```shell
43-
git checkout master -b new_branch_name
43+
git checkout main -b new_branch_name
4444
```
4545
where ```new_branch_name``` is the name of your new branch.
4646
1. Do your work and commit your changes to this branch.
47-
1. If you have drifted out of sync with the master from the
47+
1. If you have drifted out of sync with the main from the
4848
main cirq repo you may need to merge in changes. To do this,
49-
first update your local master and then merge the local master
49+
first update your local main and then merge the local main
5050
into your branch:
5151
```shell
5252
# Track the upstream repo (if your local repo hasn't):
5353
git remote add upstream https://github.com/quantumlib/Cirq.git
5454
55-
# Update your local master.
55+
# Update your local main.
5656
git fetch upstream
57-
git checkout master
58-
git merge upstream/master
59-
# Merge local master into your branch.
57+
git checkout main
58+
git merge upstream/main
59+
# Merge local main into your branch.
6060
git checkout new_branch_name
61-
git merge master
61+
git merge main
6262
```
6363
You may need to fix merge conflicts for both of these merge
6464
commands.

README.rst

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
.. image:: https://raw.githubusercontent.com/quantumlib/Cirq/master/docs/images/Cirq_logo_color.png
1+
.. image:: https://raw.githubusercontent.com/quantumlib/Cirq/main/docs/images/Cirq_logo_color.png
22
:target: https://github.com/quantumlib/cirq
33
:alt: Cirq
44
:width: 500px
@@ -10,7 +10,7 @@ circuits and running them against quantum computers and simulators.
1010
:target: https://github.com/quantumlib/Cirq
1111
:alt: Build Status
1212

13-
.. image:: https://codecov.io/gh/quantumlib/Cirq/branch/master/graph/badge.svg
13+
.. image:: https://codecov.io/gh/quantumlib/Cirq/branch/main/graph/badge.svg
1414
:target: https://codecov.io/gh/quantumlib/Cirq
1515

1616
.. image:: https://badge.fury.io/py/cirq.svg
@@ -26,7 +26,7 @@ Installation and Documentation
2626

2727
Cirq documentation is available at `quantumai.google/cirq <https://quantumai.google/cirq>`_.
2828

29-
Documentation for the latest **pre-release** version of cirq (tracks the repository's master branch; what you get if you ``pip install --pre cirq``), is available `here <https://quantumai.google/reference/python/cirq/all_symbols?version=nightly>`__.
29+
Documentation for the latest **pre-release** version of cirq (tracks the repository's main branch; what you get if you ``pip install --pre cirq``), is available `here <https://quantumai.google/reference/python/cirq/all_symbols?version=nightly>`__.
3030

3131
Documentation for the latest **stable** version of cirq (what you get if you ``pip install cirq``) is available `here <https://quantumai.google/reference/python/cirq/all_symbols>`__.
3232

@@ -98,10 +98,10 @@ Cirq Contributors Community
9898
---------------------------
9999

100100
We welcome contributions! Before opening your first PR, a good place to start is to read our
101-
`guidelines <https://github.com/quantumlib/cirq/blob/master/CONTRIBUTING.md>`__.
101+
`guidelines <https://github.com/quantumlib/cirq/blob/main/CONTRIBUTING.md>`__.
102102

103103
We are dedicated to cultivating an open and inclusive community to build software for near term quantum computers.
104-
Please read our `code of conduct <https://github.com/quantumlib/cirq/blob/master/CODE_OF_CONDUCT.md>`__ for the rules of engagement within our community.
104+
Please read our `code of conduct <https://github.com/quantumlib/cirq/blob/main/CODE_OF_CONDUCT.md>`__ for the rules of engagement within our community.
105105

106106
For real time informal discussions about Cirq, join our `cirqdev <https://gitter.im/cirqdev/community>`__ Gitter channel, come hangout with us!
107107

cirq-core/README.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
.. image:: https://raw.githubusercontent.com/quantumlib/Cirq/master/docs/images/Cirq_logo_color.png
1+
.. image:: https://raw.githubusercontent.com/quantumlib/Cirq/main/docs/images/Cirq_logo_color.png
22
:target: https://github.com/quantumlib/cirq
33
:alt: Cirq
44
:width: 500px

cirq-ft/README.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
.. image:: https://raw.githubusercontent.com/quantumlib/Cirq/master/docs/images/Cirq_logo_color.png
1+
.. image:: https://raw.githubusercontent.com/quantumlib/Cirq/main/docs/images/Cirq_logo_color.png
22
:target: https://github.com/quantumlib/cirq
33
:alt: cirq-ft
44
:width: 500px

cirq-web/circuit_example.ipynb

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -44,10 +44,10 @@
4444
"\n",
4545
"<table class=\"tfo-notebook-buttons\" align=\"left\">\n",
4646
" <td>\n",
47-
" <a target=\"_blank\" href=\"https://colab.research.google.com/github/quantumlib/Cirq/blob/master/cirq-web/circuit_example.ipynb\"><img src=\"https://quantumai.google/site-assets/images/buttons/colab_logo_1x.png\" />Run in Google Colab</a>\n",
47+
" <a target=\"_blank\" href=\"https://colab.research.google.com/github/quantumlib/Cirq/blob/main/cirq-web/circuit_example.ipynb\"><img src=\"https://quantumai.google/site-assets/images/buttons/colab_logo_1x.png\" />Run in Google Colab</a>\n",
4848
" </td>\n",
4949
" <td>\n",
50-
" <a target=\"_blank\" href=\"https://github.com/quantumlib/Cirq/blob/master/cirq-web/circuit_example.ipynb\"><img src=\"https://quantumai.google/site-assets/images/buttons/github_logo_1x.png\" />View source on GitHub</a>\n",
50+
" <a target=\"_blank\" href=\"https://github.com/quantumlib/Cirq/blob/main/cirq-web/circuit_example.ipynb\"><img src=\"https://quantumai.google/site-assets/images/buttons/github_logo_1x.png\" />View source on GitHub</a>\n",
5151
" </td>\n",
5252
"</table>"
5353
]

docs/_template.ipynb

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -51,10 +51,10 @@
5151
" <a target=\"_blank\" href=\"https://quantumai.google/cirq/$$$REPLACE_WITH_SITE_URL$$$>\"><img src=\"https://quantumai.google/site-assets/images/buttons/quantumai_logo_1x.png\" />View on QuantumAI</a>\n",
5252
" </td>\n",
5353
" <td>\n",
54-
" <a target=\"_blank\" href=\"https://colab.research.google.com/github/quantumlib/Cirq/blob/master/docs/$$$REPLACE_WITH_NOTEBOOK_PATH$$$\"><img src=\"https://quantumai.google/site-assets/images/buttons/colab_logo_1x.png\" />Run in Google Colab</a>\n",
54+
" <a target=\"_blank\" href=\"https://colab.research.google.com/github/quantumlib/Cirq/blob/main/docs/$$$REPLACE_WITH_NOTEBOOK_PATH$$$\"><img src=\"https://quantumai.google/site-assets/images/buttons/colab_logo_1x.png\" />Run in Google Colab</a>\n",
5555
" </td>\n",
5656
" <td>\n",
57-
" <a target=\"_blank\" href=\"https://github.com/quantumlib/Cirq/blob/master/docs/$$$REPLACE_WITH_NOTEBOOK_PATH$$$\"><img src=\"https://quantumai.google/site-assets/images/buttons/github_logo_1x.png\" />View source on GitHub</a>\n",
57+
" <a target=\"_blank\" href=\"https://github.com/quantumlib/Cirq/blob/main/docs/$$$REPLACE_WITH_NOTEBOOK_PATH$$$\"><img src=\"https://quantumai.google/site-assets/images/buttons/github_logo_1x.png\" />View source on GitHub</a>\n",
5858
" </td>\n",
5959
" <td>\n",
6060
" <a href=\"https://storage.googleapis.com/tensorflow_docs/Cirq/docs/$$$REPLACE_WITH_NOTEBOOK_PATH$$$\"><img src=\"https://quantumai.google/site-assets/images/buttons/download_icon_1x.png\" />Download notebook</a>\n",

docs/build/circuits.ipynb

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -51,10 +51,10 @@
5151
" <a target=\"_blank\" href=\"https://quantumai.google/cirq/build/circuits\"><img src=\"https://quantumai.google/site-assets/images/buttons/quantumai_logo_1x.png\" />View on QuantumAI</a>\n",
5252
" </td>\n",
5353
" <td>\n",
54-
" <a target=\"_blank\" href=\"https://colab.research.google.com/github/quantumlib/Cirq/blob/master/docs/build/circuits.ipynb\"><img src=\"https://quantumai.google/site-assets/images/buttons/colab_logo_1x.png\" />Run in Google Colab</a>\n",
54+
" <a target=\"_blank\" href=\"https://colab.research.google.com/github/quantumlib/Cirq/blob/main/docs/build/circuits.ipynb\"><img src=\"https://quantumai.google/site-assets/images/buttons/colab_logo_1x.png\" />Run in Google Colab</a>\n",
5555
" </td>\n",
5656
" <td>\n",
57-
" <a target=\"_blank\" href=\"https://github.com/quantumlib/Cirq/blob/master/docs/build/circuits.ipynb\"><img src=\"https://quantumai.google/site-assets/images/buttons/github_logo_1x.png\" />View source on GitHub</a>\n",
57+
" <a target=\"_blank\" href=\"https://github.com/quantumlib/Cirq/blob/main/docs/build/circuits.ipynb\"><img src=\"https://quantumai.google/site-assets/images/buttons/github_logo_1x.png\" />View source on GitHub</a>\n",
5858
" </td>\n",
5959
" <td>\n",
6060
" <a href=\"https://storage.googleapis.com/tensorflow_docs/Cirq/docs/build/circuits.ipynb\"><img src=\"https://quantumai.google/site-assets/images/buttons/download_icon_1x.png\" />Download notebook</a>\n",

docs/build/classical_control.ipynb

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -42,10 +42,10 @@
4242
" <a target=\"_blank\" href=\"https://quantumai.google/cirq/build/classical_control\"><img src=\"https://quantumai.google/site-assets/images/buttons/quantumai_logo_1x.png\" />View on QuantumAI</a>\n",
4343
" </td>\n",
4444
" <td>\n",
45-
" <a target=\"_blank\" href=\"https://colab.research.google.com/github/quantumlib/Cirq/blob/master/docs/build/classical_control.ipynb\"><img src=\"https://quantumai.google/site-assets/images/buttons/colab_logo_1x.png\" />Run in Google Colab</a>\n",
45+
" <a target=\"_blank\" href=\"https://colab.research.google.com/github/quantumlib/Cirq/blob/main/docs/build/classical_control.ipynb\"><img src=\"https://quantumai.google/site-assets/images/buttons/colab_logo_1x.png\" />Run in Google Colab</a>\n",
4646
" </td>\n",
4747
" <td>\n",
48-
" <a target=\"_blank\" href=\"https://github.com/quantumlib/Cirq/blob/master/docs/build/classical_control.ipynb\"><img src=\"https://quantumai.google/site-assets/images/buttons/github_logo_1x.png\" />View source on GitHub</a>\n",
48+
" <a target=\"_blank\" href=\"https://github.com/quantumlib/Cirq/blob/main/docs/build/classical_control.ipynb\"><img src=\"https://quantumai.google/site-assets/images/buttons/github_logo_1x.png\" />View source on GitHub</a>\n",
4949
" </td>\n",
5050
" <td>\n",
5151
" <a href=\"https://storage.googleapis.com/tensorflow_docs/Cirq/docs/build/classical_control.ipynb\"><img src=\"https://quantumai.google/site-assets/images/buttons/download_icon_1x.png\" />Download notebook</a>\n",
@@ -309,7 +309,7 @@
309309
"source": [
310310
"The measurement key `a` is present both in the outer circuit and the `FrozenCircuit` nested within it, but these two keys are different due to their different scopes. After unrolling the inner circuit twice, these inner `a`s get prefixed by the repetition number and becomes new, separate measurement keys, `0:a` and `1:a`, that don't interact with each other or the original `a`. \n",
311311
"\n",
312-
"More complex scoping behavior is described in the [classically controlled operation tests](https://github.com/quantumlib/Cirq/blob/master/cirq-core/cirq/ops/classically_controlled_operation_test.py)."
312+
"More complex scoping behavior is described in the [classically controlled operation tests](https://github.com/quantumlib/Cirq/blob/main/cirq-core/cirq/ops/classically_controlled_operation_test.py)."
313313
]
314314
},
315315
{

docs/build/custom_gates.ipynb

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -51,10 +51,10 @@
5151
" <a target=\"_blank\" href=\"https://quantumai.google/cirq/build/custom_gates\"><img src=\"https://quantumai.google/site-assets/images/buttons/quantumai_logo_1x.png\" />View on QuantumAI</a>\n",
5252
" </td>\n",
5353
" <td>\n",
54-
" <a target=\"_blank\" href=\"https://colab.research.google.com/github/quantumlib/Cirq/blob/master/docs/build/custom_gates.ipynb\"><img src=\"https://quantumai.google/site-assets/images/buttons/colab_logo_1x.png\" />Run in Google Colab</a>\n",
54+
" <a target=\"_blank\" href=\"https://colab.research.google.com/github/quantumlib/Cirq/blob/main/docs/build/custom_gates.ipynb\"><img src=\"https://quantumai.google/site-assets/images/buttons/colab_logo_1x.png\" />Run in Google Colab</a>\n",
5555
" </td>\n",
5656
" <td>\n",
57-
" <a target=\"_blank\" href=\"https://github.com/quantumlib/Cirq/blob/master/docs/build/custom_gates.ipynb\"><img src=\"https://quantumai.google/site-assets/images/buttons/github_logo_1x.png\" />View source on GitHub</a>\n",
57+
" <a target=\"_blank\" href=\"https://github.com/quantumlib/Cirq/blob/main/docs/build/custom_gates.ipynb\"><img src=\"https://quantumai.google/site-assets/images/buttons/github_logo_1x.png\" />View source on GitHub</a>\n",
5858
" </td>\n",
5959
" <td>\n",
6060
" <a href=\"https://storage.googleapis.com/tensorflow_docs/Cirq/docs/build/custom_gates.ipynb\"><img src=\"https://quantumai.google/site-assets/images/buttons/download_icon_1x.png\" />Download notebook</a>\n",

docs/build/gates.ipynb

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -51,10 +51,10 @@
5151
" <a target=\"_blank\" href=\"https://quantumai.google/cirq/build/gates\"><img src=\"https://quantumai.google/site-assets/images/buttons/quantumai_logo_1x.png\" />View on QuantumAI</a>\n",
5252
" </td>\n",
5353
" <td>\n",
54-
" <a target=\"_blank\" href=\"https://colab.research.google.com/github/quantumlib/Cirq/blob/master/docs/build/gates.ipynb\"><img src=\"https://quantumai.google/site-assets/images/buttons/colab_logo_1x.png\" />Run in Google Colab</a>\n",
54+
" <a target=\"_blank\" href=\"https://colab.research.google.com/github/quantumlib/Cirq/blob/main/docs/build/gates.ipynb\"><img src=\"https://quantumai.google/site-assets/images/buttons/colab_logo_1x.png\" />Run in Google Colab</a>\n",
5555
" </td>\n",
5656
" <td>\n",
57-
" <a target=\"_blank\" href=\"https://github.com/quantumlib/Cirq/blob/master/docs/build/gates.ipynb\"><img src=\"https://quantumai.google/site-assets/images/buttons/github_logo_1x.png\" />View source on GitHub</a>\n",
57+
" <a target=\"_blank\" href=\"https://github.com/quantumlib/Cirq/blob/main/docs/build/gates.ipynb\"><img src=\"https://quantumai.google/site-assets/images/buttons/github_logo_1x.png\" />View source on GitHub</a>\n",
5858
" </td>\n",
5959
" <td>\n",
6060
" <a href=\"https://storage.googleapis.com/tensorflow_docs/Cirq/docs/build/gates.ipynb\"><img src=\"https://quantumai.google/site-assets/images/buttons/download_icon_1x.png\" />Download notebook</a>\n",

0 commit comments

Comments
 (0)