Skip to content

Commit 434c7b1

Browse files
authored
Move master to main (#322)
1 parent aab5392 commit 434c7b1

File tree

4 files changed

+21
-21
lines changed

4 files changed

+21
-21
lines changed

README.rst

+5-5
Original file line numberDiff line numberDiff line change
@@ -7,14 +7,14 @@ codecs for use in data storage and communication applications.
77
.. image:: https://readthedocs.org/projects/numcodecs/badge/?version=latest
88
:target: http://numcodecs.readthedocs.io/en/latest/?badge=latest
99

10-
.. image:: https://github.com/zarr-developers/numcodecs/workflows/Linux%20CI/badge.svg?branch=master
10+
.. image:: https://github.com/zarr-developers/numcodecs/workflows/Linux%20CI/badge.svg?branch=main
1111
:target: https://github.com/zarr-developers/numcodecs/actions?query=workflow%3A%22Linux+CI%22
1212

13-
.. image:: https://github.com/zarr-developers/numcodecs/workflows/OSX%20CI/badge.svg?branch=master
13+
.. image:: https://github.com/zarr-developers/numcodecs/workflows/OSX%20CI/badge.svg?branch=main
1414
:target: https://github.com/zarr-developers/numcodecs/actions?query=workflow%3A%22OSX+CI%22
1515

16-
.. image:: https://github.com/zarr-developers/numcodecs/workflows/Wheels/badge.svg?branch=master
16+
.. image:: https://github.com/zarr-developers/numcodecs/workflows/Wheels/badge.svg?branch=main
1717
:target: https://github.com/zarr-developers/numcodecs/actions?query=workflow%3AWheels
1818

19-
.. image:: https://coveralls.io/repos/github/zarr-developers/numcodecs/badge.svg?branch=master
20-
:target: https://coveralls.io/github/zarr-developers/numcodecs?branch=master
19+
.. image:: https://coveralls.io/repos/github/zarr-developers/numcodecs/badge.svg?branch=main
20+
:target: https://coveralls.io/github/zarr-developers/numcodecs?branch=main

docs/conf.py

+5-5
Original file line numberDiff line numberDiff line change
@@ -65,8 +65,8 @@ def __getattr__(cls, name):
6565
# The encoding of source files.
6666
#source_encoding = 'utf-8-sig'
6767

68-
# The master toctree document.
69-
master_doc = 'index'
68+
# The main toctree document.
69+
main_doc = 'index'
7070

7171
# General information about the project.
7272
project = 'numcodecs'
@@ -249,7 +249,7 @@ def __getattr__(cls, name):
249249
# (source start file, target name, title,
250250
# author, documentclass [howto, manual, or own class]).
251251
latex_documents = [
252-
(master_doc, 'numcodecs.tex', 'numcodecs Documentation',
252+
(main_doc, 'numcodecs.tex', 'numcodecs Documentation',
253253
'Alistair Miles', 'manual'),
254254
]
255255

@@ -279,7 +279,7 @@ def __getattr__(cls, name):
279279
# One entry per manual page. List of tuples
280280
# (source start file, name, description, authors, manual section).
281281
man_pages = [
282-
(master_doc, 'numcodecs', 'numcodecs Documentation',
282+
(main_doc, 'numcodecs', 'numcodecs Documentation',
283283
[author], 1)
284284
]
285285

@@ -293,7 +293,7 @@ def __getattr__(cls, name):
293293
# (source start file, target name, title, author,
294294
# dir menu entry, description, category)
295295
texinfo_documents = [
296-
(master_doc, 'numcodecs', 'numcodecs Documentation',
296+
(main_doc, 'numcodecs', 'numcodecs Documentation',
297297
author, 'numcodecs', 'One line description of project.',
298298
'Miscellaneous'),
299299
]

docs/contributing.rst

+10-10
Original file line numberDiff line numberDiff line change
@@ -108,25 +108,25 @@ report the bug or propose the feature you'd like to add.
108108
It's best to create a new, separate branch for each piece of work you want to do. E.g.::
109109

110110
git fetch upstream
111-
git checkout -b shiny-new-feature upstream/master
111+
git checkout -b shiny-new-feature upstream/main
112112

113113
This changes your working directory to the 'shiny-new-feature' branch. Keep any changes in
114114
this branch specific to one bug or feature so it is clear what the branch brings to
115115
NumCodecs.
116116

117117
To update this branch with latest code from NumCodecs, you can retrieve the changes from
118-
the master branch and perform a rebase::
118+
the main branch and perform a rebase::
119119

120120
git fetch upstream
121-
git rebase upstream/master
121+
git rebase upstream/main
122122

123-
This will replay your commits on top of the latest NumCodecs git master. If this leads to
123+
This will replay your commits on top of the latest NumCodecs git main. If this leads to
124124
merge conflicts, these need to be resolved before submitting a pull request.
125-
Alternatively, you can merge the changes in from upstream/master instead of rebasing,
125+
Alternatively, you can merge the changes in from upstream/main instead of rebasing,
126126
which can be simpler::
127127

128128
git fetch upstream
129-
git merge upstream/master
129+
git merge upstream/main
130130

131131
Again, any conflicts need to be resolved before submitting a pull request.
132132

@@ -183,7 +183,7 @@ Documentation
183183
~~~~~~~~~~~~~
184184

185185
Docstrings for user-facing classes and functions should follow the `numpydoc
186-
<https://github.com/numpy/numpy/blob/master/doc/HOWTO_DOCUMENT.rst.txt>`_ standard,
186+
<https://numpydoc.readthedocs.io/en/latest/format.html#docstring-standard>`_ standard,
187187
including sections for Parameters and Examples. All examples will be run as doctests
188188
under Python 3.9.
189189

@@ -213,7 +213,7 @@ one core developers before being merged. Ideally, pull requests submitted by a c
213213
should be reviewed and approved by at least one other core developers before being merged.
214214

215215
Pull requests should not be merged until all CI checks have passed (Travis, AppVeyor,
216-
Coveralls) against code that has had the latest master merged in.
216+
Coveralls) against code that has had the latest main merged in.
217217

218218
Compatibility and versioning policies
219219
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
@@ -290,9 +290,9 @@ compatibility in some way.
290290
Release procedure
291291
~~~~~~~~~~~~~~~~~
292292

293-
Checkout and update the master branch::
293+
Checkout and update the main branch::
294294

295-
$ git checkout master
295+
$ git checkout main
296296
$ git pull
297297

298298
Verify all tests pass on all supported Python versions, and docs build::

docs/index.rst

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
.. numcodecs documentation master file, created by
1+
.. numcodecs documentation main file, created by
22
sphinx-quickstart on Mon May 2 21:40:09 2016.
33
44

0 commit comments

Comments
 (0)