Skip to content

armgit / manim

Public Imported from GitHub
0

A community-maintained Python framework for creating mathematical animations.

Renamed instances of master to main (#1720)

Jason Villanuevae9aa7d36964b
diff --git a/README.md b/README.md
index 813258660..5c86131ac 100644
--- a/README.md
+++ b/README.md
@@ -1,5 +1,5 @@
<p align="center">
- <a href="https://www.manim.community/"><img src="https://raw.githubusercontent.com/ManimCommunity/manim/master/logo/cropped.png"></a>
+ <a href="https://www.manim.community/"><img src="https://raw.githubusercontent.com/ManimCommunity/manim/main/logo/cropped.png"></a>
<br />
<br />
<a href="https://pypi.org/project/manim/"><img src="https://img.shields.io/pypi/v/manim.svg?style=flat&logo=pypi" alt="PyPI Latest Release"></a>
@@ -87,7 +87,7 @@ Manim also ships with a `%%manim` IPython magic which allows to use it convenien
The general usage of Manim is as follows:
-![manim-illustration](https://raw.githubusercontent.com/ManimCommunity/manim/master/docs/source/_static/command.png)
+![manim-illustration](https://raw.githubusercontent.com/ManimCommunity/manim/main/docs/source/_static/command.png)
The `-p` flag in the command above is for previewing, meaning the video file will automatically open when it is done rendering. The `-ql` flag is for a faster rendering at a lower quality.
@@ -107,7 +107,7 @@ Documentation is in progress at [ReadTheDocs](https://docs.manim.community/).
The community also maintains a docker image (`manimcommunity/manim`), which can be found [on DockerHub](https://hub.docker.com/r/manimcommunity/manim). The following tags are supported:
-- `latest` -- the most recent version corresponding to [the master branch](https://github.com/ManimCommunity/manim)
+- `latest` -- the most recent version corresponding to [the main branch](https://github.com/ManimCommunity/manim)
- `stable` -- the latest released version (according to [the releases page](https://github.com/ManimCommunity/manim/releases))
- `vX.Y.Z` -- any particular released version (according to [the releases page](https://github.com/ManimCommunity/manim/releases))
diff --git a/docker/readme.md b/docker/readme.md
index 6cb96cc45..4b80ab4ab 100644
--- a/docker/readme.md
+++ b/docker/readme.md
@@ -1,4 +1,4 @@
-See the [main README](https://github.com/ManimCommunity/manim/blob/master/README.md) for some instructions on how to use this image.
+See the [main README](https://github.com/ManimCommunity/manim/blob/main/README.md) for some instructions on how to use this image.
# Building the image
The docker image corresponding to the checked out version of the git repository
diff --git a/docs/source/contributing/development.rst b/docs/source/contributing/development.rst
index 7b3fbc5aa..529119a08 100644
--- a/docs/source/contributing/development.rst
+++ b/docs/source/contributing/development.rst
@@ -66,22 +66,22 @@ You are now ready to work on manim!
Develop your contribution
-------------------------
-#. Checkout your local repository's master branch and pull the latest
+#. Checkout your local repository's main branch and pull the latest
changes from ManimCommunity, ``upstream``, into your local repository:
.. code-block:: shell
- git checkout master
- git pull --rebase upstream master
+ git checkout main
+ git pull --rebase upstream main
#. Create a branch for the changes you want to work on rather than working
- off of master:
+ off of your local main branch:
.. code-block:: shell
- git checkout -b <new branch name> upstream/master
+ git checkout -b <new branch name> upstream/main
- This ensures you can easily update your local repository's master with the
+ This ensures you can easily update your local repository's main with the
first step and switch branches to work on multiple features.
#. Write some awesome code!
@@ -185,8 +185,8 @@ Your changes are eligible to be merged if:
#. the tests in our pipeline pass
#. at least one (two for more complex changes) Community Developer approves the changes
-You can check for merge conflicts between the current upstream/master and
-your branch by executing ``git pull upstream master`` locally. If this
+You can check for merge conflicts between the current upstream/main and
+your branch by executing ``git pull upstream main`` locally. If this
generates any merge conflicts, you need to resolve them and push an
updated version of the branch to your fork of the repository.
diff --git a/docs/source/contributing/examples.rst b/docs/source/contributing/examples.rst
index b8ed1bcce..5508460b2 100644
--- a/docs/source/contributing/examples.rst
+++ b/docs/source/contributing/examples.rst
@@ -31,7 +31,7 @@ What makes a great example
- Lots of examples (e.g. size of a plot-axis, setting opacities, making texts, etc.) will also work as images. It is a lot more convenient to see the end product immediately instead of waiting for an animation to reveal it.
-* Please ensure the examples run on the current master when you contribute an example.\
+* Please ensure the examples run on the current main branch when you contribute an example.
* If the functions used are confusing for people, make sure to add comments in the example to explain what they do.
diff --git a/docs/source/index.rst b/docs/source/index.rst
index fae4b4c65..c0327a1b2 100644
--- a/docs/source/index.rst
+++ b/docs/source/index.rst
@@ -29,7 +29,7 @@ information here will make it easier for newcomers to get started using
`our GitHub repository <https://github.com/ManimCommunity/manim>`_. If you
use Manim in a scientific context, instructions on how to cite a particular
release can be found
- `in our README <https://github.com/ManimCommunity/manim/blob/master/README.md>`_.
+ `in our README <https://github.com/ManimCommunity/manim/blob/main/README.md>`_.
.. note::
diff --git a/manim/scene/scene.py b/manim/scene/scene.py
index b49b580dd..ec9b8b157 100644
--- a/manim/scene/scene.py
+++ b/manim/scene/scene.py
@@ -1195,7 +1195,7 @@ class Scene:
dot.set_color(RED)
self.wait()
- Download the resource for the previous example `here <https://github.com/ManimCommunity/manim/blob/master/docs/source/_static/click.wav>`_ .
+ Download the resource for the previous example `here <https://github.com/ManimCommunity/manim/blob/main/docs/source/_static/click.wav>`_ .
"""
if self.renderer.skip_animations:
return