Skip to content

Commit

Permalink
Rename master to main
Browse files Browse the repository at this point in the history
Fixes #523
  • Loading branch information
mhostetter committed Nov 4, 2023
1 parent 68183fa commit dfccdea
Show file tree
Hide file tree
Showing 7 changed files with 15 additions and 15 deletions.
4 changes: 2 additions & 2 deletions .github/workflows/build.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -3,11 +3,11 @@ name: Build
on:
push:
branches:
- master
- main
- 'release/*'
pull_request:
branches:
- master
- main
- 'release/*'
workflow_call:

Expand Down
2 changes: 1 addition & 1 deletion .github/workflows/docs.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ on:
- 'release/*'
pull_request:
branches:
- master
- main
- 'release/*'
workflow_call:
workflow_dispatch:
Expand Down
4 changes: 2 additions & 2 deletions .github/workflows/lint.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -3,11 +3,11 @@ name: Lint
on:
push:
branches:
- master
- main
- 'release/*'
pull_request:
branches:
- master
- main
- 'release/*'

jobs:
Expand Down
4 changes: 2 additions & 2 deletions .github/workflows/test.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -3,11 +3,11 @@ name: Test
on:
push:
branches:
- master
- main
- 'release/*'
pull_request:
branches:
- master
- main
- 'release/*'

jobs:
Expand Down
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# ![Galois: A performant NumPy extension for Galois fields and their applications](https://raw.githubusercontent.com/mhostetter/galois/master/logo/galois-heading.png)
# ![Galois: A performant NumPy extension for Galois fields and their applications](https://raw.githubusercontent.com/mhostetter/galois/main/logo/galois-heading.png)

<div align=center>
<a href="https://pypi.org/project/galois"><img src="https://img.shields.io/pypi/v/galois"></a>
Expand All @@ -14,7 +14,7 @@
<a href="https://github.com/mhostetter/galois/actions/workflows/lint.yaml"><img src="https://github.com/mhostetter/galois/actions/workflows/lint.yaml/badge.svg"></a>
<a href="https://github.com/mhostetter/galois/actions/workflows/build.yaml"><img src="https://github.com/mhostetter/galois/actions/workflows/build.yaml/badge.svg"></a>
<a href="https://github.com/mhostetter/galois/actions/workflows/test.yaml"><img src="https://github.com/mhostetter/galois/actions/workflows/test.yaml/badge.svg"></a>
<a href="https://codecov.io/gh/mhostetter/galois"><img src="https://codecov.io/gh/mhostetter/galois/branch/master/graph/badge.svg?token=3FJML79ZUK"></a>
<a href="https://codecov.io/gh/mhostetter/galois"><img src="https://codecov.io/gh/mhostetter/galois/branch/main/graph/badge.svg?token=3FJML79ZUK"></a>
</div>

The `galois` library is a Python 3 package that extends NumPy arrays to operate over finite fields.
Expand Down
2 changes: 1 addition & 1 deletion docs/development/installation.rst
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ The latest released version of :obj:`galois` can be installed from `PyPI <https:
Install from GitHub
-------------------

The latest code on `master` can be installed using `pip` in this way.
The latest code on `main` can be installed using `pip` in this way.

.. code-block:: console
Expand Down
10 changes: 5 additions & 5 deletions docs/performance/benchmarks.rst
Original file line number Diff line number Diff line change
Expand Up @@ -129,22 +129,22 @@ advised to pass extra arguments to format the display `--benchmark-columns=min,m
Compare with a previous benchmark
---------------------------------

If you would like to compare the performance impact of a branch, first run a benchmark on `master` using the `--benchmark-save` option.
If you would like to compare the performance impact of a branch, first run a benchmark on `main` using the `--benchmark-save` option.
This will save the file `.benchmarks/0001_master.json`.

.. code-block:: console
$ git checkout master
$ python3 -m pytest benchmarks/test_field_arithmetic.py --benchmark-save=master --benchmark-columns=min,max,mean,stddev,median --benchmark-sort=name
$ git checkout main
$ python3 -m pytest benchmarks/test_field_arithmetic.py --benchmark-save=main --benchmark-columns=min,max,mean,stddev,median --benchmark-sort=name
Next, run a benchmark on the branch under test while comparing against the benchmark from `master`.
Next, run a benchmark on the branch under test while comparing against the benchmark from `main`.

.. code-block:: console
$ git checkout branch
$ python3 -m pytest benchmarks/test_field_arithmetic.py --benchmark-compare=0001_master --benchmark-columns=min,max,mean,stddev,median --benchmark-sort=name
Or, save a benchmark run from `branch` and compare it explicitly against the one from `master`. This benchmark run will save the file `.benchmarks/0001_branch.json`.
Or, save a benchmark run from `branch` and compare it explicitly against the one from `main`. This benchmark run will save the file `.benchmarks/0001_branch.json`.

.. code-block:: console
Expand Down

0 comments on commit dfccdea

Please sign in to comment.