Skip to content

Commit 954605e

Browse files
stefanvrossbar
andauthored
MAINT: Update master to main after branch rename (numpygh-18544)
* Upload docs to main branch of neps/devdocs * Update `master` to `main` to be consistent with current state of renaming * Remove badges from README * Replace remaining instances of `master` with `main` * Add back logo * Fix CircleCI branch checks * Fix GA branch name * master->main in issue templates. * master->main for 2 links to numpy archive. * Change master to main in NEP 23 Co-authored-by: Ross Barnowski <[email protected]>
1 parent 7134dcf commit 954605e

36 files changed

+97
-104
lines changed

.circleci/config.yml

+4-4
Original file line numberDiff line numberDiff line change
@@ -91,7 +91,7 @@ jobs:
9191
- run:
9292
name: deploy devdocs
9393
command: |
94-
if [ "${CIRCLE_BRANCH}" == "master" ]; then
94+
if [ "${CIRCLE_BRANCH}" == "main" ]; then
9595
touch doc/build/html/.nojekyll
9696
9797
./tools/ci/push_docs_to_repo.py doc/build/html \
@@ -101,7 +101,7 @@ jobs:
101101
--message "Docs build of $CIRCLE_SHA1" \
102102
--force
103103
else
104-
echo "Not on the master branch; skipping deployment"
104+
echo "Not on the main branch; skipping deployment"
105105
fi
106106
107107
- add_ssh_keys:
@@ -120,7 +120,7 @@ jobs:
120120
- run:
121121
name: deploy neps
122122
command: |
123-
if [ "${CIRCLE_BRANCH}" == "master" ]; then
123+
if [ "${CIRCLE_BRANCH}" == "main" ]; then
124124
touch doc/neps/_build/html/.nojekyll
125125
126126
./tools/ci/push_docs_to_repo.py doc/neps/_build/html \
@@ -130,5 +130,5 @@ jobs:
130130
--message "Docs build of $CIRCLE_SHA1" \
131131
--force
132132
else
133-
echo "Not on the master branch; skipping deployment"
133+
echo "Not on the main branch; skipping deployment"
134134
fi

.github/CONTRIBUTING.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ also include a brief, self-contained code example that demonstrates the problem.
88

99
If you are reporting a segfault please include a GDB traceback, which you can
1010
generate by following
11-
[these instructions.](https://github.com/numpy/numpy/blob/master/doc/source/dev/development_environment.rst#debugging)
11+
[these instructions.](https://github.com/numpy/numpy/blob/main/doc/source/dev/development_environment.rst#debugging)
1212

1313
## Contributing code
1414

.github/ISSUE_TEMPLATE/bug-report.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ import numpy as np
2020

2121
<!-- If you are reporting a segfault please include a GDB traceback, which you
2222
can generate by following
23-
https://github.com/numpy/numpy/blob/master/doc/source/dev/development_environment.rst#debugging -->
23+
https://github.com/numpy/numpy/blob/main/doc/source/dev/development_environment.rst#debugging -->
2424

2525
<!-- Full error message, if any (starting from line Traceback: ...) -->
2626

.github/ISSUE_TEMPLATE/feature-request.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -12,5 +12,5 @@ post your idea on the [numpy-discussion mailing list]
1212
(https://mail.python.org/mailman/listinfo/numpy-discussion) to explain your
1313
reasoning in addition to opening an issue or pull request. You can also check
1414
out our [Contributor Guide]
15-
(https://github.com/numpy/numpy/blob/master/doc/source/dev/index.rst) if you
15+
(https://github.com/numpy/numpy/blob/main/doc/source/dev/index.rst) if you
1616
need more information. -->

.github/ISSUE_TEMPLATE/post-install.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ labels: 32 - Installation
1515

1616
<!-- If you are reporting a segfault please include a GDB traceback, which you
1717
can generate by following
18-
https://github.com/numpy/numpy/blob/master/doc/source/dev/development_environment.rst#debugging -->
18+
https://github.com/numpy/numpy/blob/main/doc/source/dev/development_environment.rst#debugging -->
1919

2020
<!-- Full error message, if any (starting from line Traceback: ...) -->
2121

.github/workflows/build_test.yml

+2-2
Original file line numberDiff line numberDiff line change
@@ -3,11 +3,11 @@ name: Build_Test
33
on:
44
push:
55
branches:
6-
- master
6+
- main
77
- maintenance/**
88
pull_request:
99
branches:
10-
- master
10+
- main
1111
- maintenance/**
1212

1313
defaults:

README.md

-7
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,5 @@
11
# <img alt="NumPy" src="/branding/logo/primary/numpylogo.svg" height="60">
22

3-
[![Travis CI](https://img.shields.io/travis/com/numpy/numpy/master?label=Travis%20CI)](
4-
https://travis-ci.com/github/numpy/numpy)
5-
[![Azure](https://dev.azure.com/numpy/numpy/_apis/build/status/azure-pipeline%20numpy.numpy)](
6-
https://dev.azure.com/numpy/numpy/_build/latest?definitionId=5)
7-
[![codecov](https://codecov.io/gh/numpy/numpy/branch/master/graph/badge.svg)](
8-
https://codecov.io/gh/numpy/numpy)
9-
103
NumPy is the fundamental package needed for scientific computing with Python.
114

125
- **Website:** https://www.numpy.org

benchmarks/README.rst

+1-1
Original file line numberDiff line numberDiff line change
@@ -50,7 +50,7 @@ Compare change in benchmark results to another version/commit/branch::
5050

5151
python runtests.py --bench-compare v1.6.2 bench_core
5252
python runtests.py --bench-compare 8bf4e9b bench_core
53-
python runtests.py --bench-compare master bench_core
53+
python runtests.py --bench-compare main bench_core
5454

5555
All of the commands above display the results in plain text in
5656
the console, and the results are not saved for comparison with

doc/DISTUTILS.rst.txt

+1-1
Original file line numberDiff line numberDiff line change
@@ -472,7 +472,7 @@ by these modules during the build process are ready to be compiled. This
472472
form of generic typing is also supported for C header files (preprocessed
473473
to produce ``.h`` files).
474474

475-
.. _conv_template.py: https://github.com/numpy/numpy/blob/master/numpy/distutils/conv_template.py
475+
.. _conv_template.py: https://github.com/numpy/numpy/blob/main/numpy/distutils/conv_template.py
476476

477477
Useful functions in ``numpy.distutils.misc_util``
478478
-------------------------------------------------

doc/HOWTO_RELEASE.rst.txt

+6-6
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ Source tree
1818

1919
NumPy Docs
2020
----------
21-
- https://github.com/numpy/numpy/blob/master/doc/HOWTO_RELEASE.rst.txt
21+
- https://github.com/numpy/numpy/blob/main/doc/HOWTO_RELEASE.rst.txt
2222

2323

2424
SciPy.org wiki
@@ -35,7 +35,7 @@ Supported platforms and versions
3535
================================
3636
:ref:`NEP 29 <NEP29>` outlines which Python versions
3737
are supported; For the first half of 2020, this will be Python >= 3.6. We test
38-
NumPy against all these versions every time we merge code to master. Binary
38+
NumPy against all these versions every time we merge code to main. Binary
3939
installers may be available for a subset of these versions (see below).
4040

4141
OS X
@@ -185,7 +185,7 @@ A typical release schedule is one beta, two release candidates and a final
185185
release. It's best to discuss the timing on the mailing list first, in order
186186
for people to get their commits in on time, get doc wiki edits merged, etc.
187187
After a date is set, create a new maintenance/x.y.z branch, add new empty
188-
release notes for the next version in the master branch and update the Trac
188+
release notes for the next version in the main branch and update the Trac
189189
Milestones.
190190

191191

@@ -336,8 +336,8 @@ to public keyservers, with a command such as::
336336
gpg --send-keys <yourkeyid>
337337

338338

339-
Update the version of the master branch
340-
---------------------------------------
339+
Update the version of the main branch
340+
-------------------------------------
341341
Increment the release number in setup.py. Release candidates should have "rc1"
342342
(or "rc2", "rcN") appended to the X.Y.Z format.
343343

@@ -492,5 +492,5 @@ After the final release is announced, a few administrative tasks are left to be
492492
done:
493493

494494
- Forward port changes in the release branch to release notes and release
495-
scripts, if any, to master branch.
495+
scripts, if any, to main branch.
496496
- Update the Milestones in Trac.

doc/RELEASE_WALKTHROUGH.rst.txt

+3-3
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,7 @@ appended to ``doc/release/1.19.0-notes.rst`` for patch release, though not for
2929
new releases like ``1.19.0``, as the changelogs for ``*.0`` releases tend to be
3030
excessively long. The ``doc/source/release.rst`` file should also be updated
3131
with a link to the new release notes. These changes should be committed to the
32-
maintenance branch, and later will be forward ported to master. The changelog
32+
maintenance branch, and later will be forward ported to main. The changelog
3333
should be reviewed for name duplicates or short names and the ``.mailmap`` file
3434
updated if needed.
3535

@@ -292,7 +292,7 @@ python-announce-list is BCC so that replies will not be sent to that list.
292292
Post-Release Tasks
293293
------------------
294294

295-
Checkout master and forward port the documentation changes::
295+
Checkout main and forward port the documentation changes::
296296

297297
$ git checkout -b post-1.19.0-release-update
298298
$ git checkout maintenance/1.19.x doc/source/release/1.19.0-notes.rst
@@ -301,7 +301,7 @@ Checkout master and forward port the documentation changes::
301301
$ gvim doc/source/release.rst # Add link to new notes
302302
$ git add doc/changelog/1.19.0-changelog.rst doc/source/release/1.19.0-notes.rst
303303
$ git status # check status before commit
304-
$ git commit -a -m"REL: Update master after 1.19.0 release."
304+
$ git commit -a -m"REL: Update main after 1.19.0 release."
305305
$ git push origin HEAD
306306

307307
Go to github and make a PR.

doc/TESTS.rst.txt

+1-1
Original file line numberDiff line numberDiff line change
@@ -278,7 +278,7 @@ minor variations, it can be helpful to create a base class containing
278278
all the common tests, and then create a subclass for each variation.
279279
Several examples of this technique exist in NumPy; below are excerpts
280280
from one in `numpy/linalg/tests/test_linalg.py
281-
<https://github.com/numpy/numpy/blob/master/numpy/linalg/tests/test_linalg.py>`__::
281+
<https://github.com/numpy/numpy/blob/main/numpy/linalg/tests/test_linalg.py>`__::
282282

283283
class LinalgTestCase:
284284
def test_single(self):

doc/neps/nep-0000.rst

+1-1
Original file line numberDiff line numberDiff line change
@@ -278,7 +278,7 @@ References and Footnotes
278278

279279
.. [1] This historical record is available by the normal git commands
280280
for retrieving older revisions, and can also be browsed on
281-
`GitHub <https://github.com/numpy/numpy/tree/master/doc/neps>`_.
281+
`GitHub <https://github.com/numpy/numpy/tree/main/doc/neps>`_.
282282
283283
.. [2] The URL for viewing NEPs on the web is
284284
https://www.numpy.org/neps/.

doc/neps/nep-0001-npy-format.rst

+1-1
Original file line numberDiff line numberDiff line change
@@ -292,7 +292,7 @@ included in the 1.9.0 release of numpy.
292292
Specifically, the file format.py in this directory implements the
293293
format as described here.
294294

295-
https://github.com/numpy/numpy/blob/master/numpy/lib/format.py
295+
https://github.com/numpy/numpy/blob/main/numpy/lib/format.py
296296

297297

298298
References

doc/neps/nep-0016-abstract-array.rst

+1-1
Original file line numberDiff line numberDiff line change
@@ -141,7 +141,7 @@ Notes:
141141
In practice, either way we'd only do the full test after first
142142
checking for well-known types like ``ndarray``, ``list``, etc. `This
143143
is how NumPy currently checks for other double-underscore attributes
144-
<https://github.com/numpy/numpy/blob/master/numpy/core/src/private/get_attr_string.h>`__
144+
<https://github.com/numpy/numpy/blob/main/numpy/core/src/private/get_attr_string.h>`__
145145
and the same idea applies here to either approach. So these numbers
146146
won't affect the common case, just the case where we actually have an
147147
``AbstractArray``, or else another third-party object that will end up

doc/neps/nep-0023-backwards-compatibility.rst

+6-6
Original file line numberDiff line numberDiff line change
@@ -95,10 +95,10 @@ that can be used to assess such impact include:
9595
analysis tools to determine where and how the functionality is used.
9696
- Test prominent downstream libraries against a development build of NumPy
9797
containing the proposed change to get real-world data on its impact.
98-
- Make a change in master and revert it before release if it causes problems.
99-
We encourage other packages to test against NumPy's master branch and if
100-
that's too burdensome, then at least to test pre-releases. This often
101-
turns up issues quickly.
98+
- Make a change on the main branch and revert it before release if it
99+
causes problems. We encourage other packages to test against
100+
NumPy's main branch and if that's too burdensome, then at least to
101+
test pre-releases. This often turns up issues quickly.
102102

103103
Alternatives to deprecations
104104
````````````````````````````
@@ -279,8 +279,8 @@ introduced for v1.11.0 and turned into a hard error for v1.12.0.
279279

280280
This change was disruptive, however it did catch real bugs in, e.g., SciPy and
281281
scikit-learn. Overall the change was worth the cost, and introducing it in
282-
master first to allow testing, then removing it again before a release, is a
283-
useful strategy.
282+
the main branch first to allow testing, then removing it again before
283+
a release, is a useful strategy.
284284

285285
Similar deprecations that also look like good examples of
286286
cleanups/improvements:

doc/neps/nep-0024-missing-data-2.rst

+1-1
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ Abstract
1414
--------
1515

1616
*Context: this NEP was written as an alternative to NEP 12, which at the time of writing
17-
had an implementation that was merged into the NumPy master branch.*
17+
had an implementation that was merged into the NumPy main branch.*
1818

1919
The principle of this NEP is to separate the APIs for masking and for missing values, according to
2020

doc/neps/nep-0025-missing-data-3.rst

+1-1
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ Abstract
1414

1515
*Context: this NEP was written as an additional alternative to NEP 12 (NEP 24
1616
is another alternative), which at the time of writing had an implementation
17-
that was merged into the NumPy master branch.*
17+
that was merged into the NumPy main branch.*
1818

1919
To try and make more progress on the whole missing values/masked arrays/...
2020
debate, it seems useful to have a more technical discussion of the pieces

doc/neps/nep-0026-missing-data-summary.rst

+4-4
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ The debate about how NumPy should handle missing data, a subject with
1717
many preexisting approaches, requirements, and conventions, has been long and
1818
contentious. There has been more than one proposal for how to implement
1919
support into NumPy, and there is a testable implementation which is
20-
merged into NumPy's current master. The vast number of emails and differing
20+
merged into NumPy's current main. The vast number of emails and differing
2121
points of view has made it difficult for interested parties to understand
2222
the issues and be comfortable with the direction NumPy is going.
2323

@@ -565,7 +565,7 @@ Recommendations for Moving Forward
565565
we're going to have to figure out how to experiment with such
566566
changes out-of-core if NumPy is to continue to evolve without
567567
forking -- might as well do it now. The existing code can live in
568-
master, disabled, or it can live in a branch -- it'll still be there
568+
the main branch, be disabled, or live its own branch -- it'll still be there
569569
once we know what we're doing.
570570

571571
**Mark** thinks we should:
@@ -576,8 +576,8 @@ Recommendations for Moving Forward
576576
A more detailed rationale for this recommendation is:
577577

578578
* A solid preliminary NA-mask implementation is currently in NumPy
579-
master. This implementation has been extensively tested
580-
against scipy and other third-party packages, and has been in master
579+
main. This implementation has been extensively tested
580+
against scipy and other third-party packages, and has been in main
581581
in a stable state for a significant amount of time.
582582
* This implementation integrates deeply with the core, providing an
583583
interface which is usable in the same way R's NA support is. It

doc/neps/nep-0036-fair-play.rst

+1-1
Original file line numberDiff line numberDiff line change
@@ -48,7 +48,7 @@ identifying the problematic release, locating alterations,
4848
and determining an appropriate course of action.
4949

5050
During a community call on `October 16th, 2019
51-
<https://github.com/numpy/archive/blob/master/status_meetings/status-2019-10-16.md>`__
51+
<https://github.com/numpy/archive/blob/main/status_meetings/status-2019-10-16.md>`__
5252
the community resolved to draft guidelines on the distribution of
5353
modified NumPy versions.
5454

doc/neps/nep-0046-sponsorship-guidelines.rst

+1-1
Original file line numberDiff line numberDiff line change
@@ -240,7 +240,7 @@ Discussion
240240
References and Footnotes
241241
------------------------
242242

243-
- `Inside NumPy: preparing for the next decade <https://github.com/numpy/archive/blob/master/content/inside_numpy_presentation_SciPy2019.pdf>`__ presentation at SciPy'19 discussing the impact of the first NumPy grant.
243+
- `Inside NumPy: preparing for the next decade <https://github.com/numpy/archive/blob/main/content/inside_numpy_presentation_SciPy2019.pdf>`__ presentation at SciPy'19 discussing the impact of the first NumPy grant.
244244
- `Issue <https://github.com/numpy/numpy/issues/13393>`__ and
245245
`email <https://mail.python.org/pipermail/numpy-discussion/2019-April/079371.html>`__
246246
where IBM offered a $5,000 bounty for VSX SIMD support

doc/source/conf.py

+2-1
Original file line numberDiff line numberDiff line change
@@ -94,6 +94,7 @@ class PyTypeObject(ctypes.Structure):
9494
# The suffix of source filenames.
9595
source_suffix = '.rst'
9696

97+
# Will change to `root_doc` in Sphinx 4
9798
master_doc = 'index'
9899

99100
# General substitutions.
@@ -442,7 +443,7 @@ def linkcode_resolve(domain, info):
442443
linespec = ""
443444

444445
if 'dev' in numpy.__version__:
445-
return "https://github.com/numpy/numpy/blob/master/numpy/%s%s" % (
446+
return "https://github.com/numpy/numpy/blob/main/numpy/%s%s" % (
446447
fn, linespec)
447448
else:
448449
return "https://github.com/numpy/numpy/blob/v%s/numpy/%s%s" % (

0 commit comments

Comments
 (0)