Replace references to master branch (#2210)

Commit history before merge:

* Replace references to master branch
* Update .flake8 to reference docs on RTD

  We're moving away from GitHub as a documentation host to only RTD because
  it's makes our lives easier creating good docs. I know this link is dead right now,
  but it won't be once we release a new version with the documentation reorganization
  changes (which should be soon!).

  Co-authored-by: Richard Si <63936253+ichard26@users.noreply.github.com>

diff --git a/.flake8 b/.flake8
index 656c0df24ee551f358bebbd7db1fc44ba47f2f8d..68d15015a37cbe42ec54df8d08dca90cc4dc898d 100644 (file)
--- a/.flake8
+++ b/.flake8
@@ -1,7 +1,7 @@
 [flake8]
 extend-ignore = E203, E266, E501
 # line length is intentionally set to 80 here because black uses Bugbear
 [flake8]
 extend-ignore = E203, E266, E501
 # line length is intentionally set to 80 here because black uses Bugbear

-# See https://github.com/psf/black/blob/master/docs/the_black_code_style.md#line-length for more details
+# See https://black.readthedocs.io/en/stable/the_black_code_style/current_style.html#line-length for more details

 max-line-length = 80
 max-complexity = 18
 select = B,C,E,F,W,T4,B9
 max-line-length = 80
 max-complexity = 18
 select = B,C,E,F,W,T4,B9

diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md
index 3b59906594a34c4423ee36e17818ce6b25e732ca..c6c80be5345b8fa1ba4acb6ee84f6c07ba48a222 100644 (file)
--- a/.github/ISSUE_TEMPLATE/bug_report.md
+++ b/.github/ISSUE_TEMPLATE/bug_report.md
@@ -18,13 +18,13 @@ assignees: ""
 
 **Environment (please complete the following information):**
 
 
 **Environment (please complete the following information):**
 

-- Version: \[e.g. master\]
+- Version: \[e.g. main\]

 - OS and Python version: \[e.g. Linux/Python 3.7.4rc1\]
 
 - OS and Python version: \[e.g. Linux/Python 3.7.4rc1\]
 

-**Does this bug also happen on master?** To answer this, you have two options:
+**Does this bug also happen on main?** To answer this, you have two options:

 
 

-1. Use the online formatter at <https://black.vercel.app/?version=master>, which will
-   use the latest master branch.
+1. Use the online formatter at <https://black.vercel.app/?version=main>, which will use
+   the latest main branch.

 1. Or run _Black_ on your machine:
    - create a new virtualenv (make sure it's the same Python version);
    - clone this repository;
 1. Or run _Black_ on your machine:
    - create a new virtualenv (make sure it's the same Python version);
    - clone this repository;

diff --git a/CHANGES.md b/CHANGES.md
index 9b155924b7de2d195e4556255431213ef7b95766..32c2d8d7237c0bc1d936e22f8badd6a70e9ffc3a 100644 (file)
--- a/CHANGES.md
+++ b/CHANGES.md
@@ -8,6 +8,10 @@
 
 ### Documentation
 
 
 ### Documentation
 

+- Replaced all remaining references to the
+  [`master`](https://github.com/psf/black/tree/main) branch with the
+  [`main`](https://github.com/psf/black/tree/main) branch. Some additional changes in
+  the source code were also made. (#2210)

 - Sigificantly reorganized the documentation to make much more sense. Check them out by
   heading over to [the stable docs on RTD](https://black.readthedocs.io/en/stable/).
   (#2174)
 - Sigificantly reorganized the documentation to make much more sense. Check them out by
   heading over to [the stable docs on RTD](https://black.readthedocs.io/en/stable/).
   (#2174)

diff --git a/README.md b/README.md
index ceccbb79962b7506dba5efdb711d296e0d5a6a2f..beb8069c32b8380bed5fdc78663e370a50de8a47 100644 (file)
--- a/README.md
+++ b/README.md
@@ -1,4 +1,4 @@
-![Black Logo](https://raw.githubusercontent.com/psf/black/master/docs/_static/logo2-readme.png)
+![Black Logo](https://raw.githubusercontent.com/psf/black/main/docs/_static/logo2-readme.png)

 
 <h2 align="center">The Uncompromising Code Formatter</h2>
 
 
 <h2 align="center">The Uncompromising Code Formatter</h2>
 


@@ -6,8 +6,8 @@
 <a href="https://github.com/psf/black/actions"><img alt="Actions Status" src="https://github.com/psf/black/workflows/Test/badge.svg"></a>
 <a href="https://github.com/psf/black/actions"><img alt="Actions Status" src="https://github.com/psf/black/workflows/Primer/badge.svg"></a>
 <a href="https://black.readthedocs.io/en/stable/?badge=stable"><img alt="Documentation Status" src="https://readthedocs.org/projects/black/badge/?version=stable"></a>
 <a href="https://github.com/psf/black/actions"><img alt="Actions Status" src="https://github.com/psf/black/workflows/Test/badge.svg"></a>
 <a href="https://github.com/psf/black/actions"><img alt="Actions Status" src="https://github.com/psf/black/workflows/Primer/badge.svg"></a>
 <a href="https://black.readthedocs.io/en/stable/?badge=stable"><img alt="Documentation Status" src="https://readthedocs.org/projects/black/badge/?version=stable"></a>

-<a href="https://coveralls.io/github/psf/black?branch=master"><img alt="Coverage Status" src="https://coveralls.io/repos/github/psf/black/badge.svg?branch=master"></a>
-<a href="https://github.com/psf/black/blob/master/LICENSE"><img alt="License: MIT" src="https://black.readthedocs.io/en/stable/_static/license.svg"></a>
+<a href="https://coveralls.io/github/psf/black?branch=main"><img alt="Coverage Status" src="https://coveralls.io/repos/github/psf/black/badge.svg?branch=main"></a>
+<a href="https://github.com/psf/black/blob/main/LICENSE"><img alt="License: MIT" src="https://black.readthedocs.io/en/stable/_static/license.svg"></a>

 <a href="https://pypi.org/project/black/"><img alt="PyPI" src="https://img.shields.io/pypi/v/black"></a>
 <a href="https://pepy.tech/project/black"><img alt="Downloads" src="https://pepy.tech/badge/black"></a>
 <a href="https://anaconda.org/conda-forge/black/"><img alt="conda-forge" src="https://img.shields.io/conda/dn/conda-forge/black.svg?label=conda-forge"></a>
 <a href="https://pypi.org/project/black/"><img alt="PyPI" src="https://img.shields.io/pypi/v/black"></a>
 <a href="https://pepy.tech/project/black"><img alt="Downloads" src="https://pepy.tech/badge/black"></a>
 <a href="https://anaconda.org/conda-forge/black/"><img alt="conda-forge" src="https://img.shields.io/conda/dn/conda-forge/black.svg?label=conda-forge"></a>

diff --git a/docs/contributing/the_basics.md b/docs/contributing/the_basics.md
index 461bff96505c6dfd2a8b717bd0699c5afe1e3c2c..d36b17eff317048cce6c1869d0c5710ee0bd2ba6 100644 (file)
--- a/docs/contributing/the_basics.md
+++ b/docs/contributing/the_basics.md
@@ -81,7 +81,7 @@ $ sphinx-build -a -b html -W docs/ docs/_build/
 if we get source code changes. It will error on formatting changes or errors. Please run
 before pushing your PR to see if you get the actions you would expect from _Black_ with
 your PR. You may need to change
 if we get source code changes. It will error on formatting changes or errors. Please run
 before pushing your PR to see if you get the actions you would expect from _Black_ with
 your PR. You may need to change

-[primer.json](https://github.com/psf/black/blob/master/src/black_primer/primer.json)
+[primer.json](https://github.com/psf/black/blob/main/src/black_primer/primer.json)

 configuration for it to pass.
 
 For more `black-primer` information visit the
 configuration for it to pass.
 
 For more `black-primer` information visit the

diff --git a/docs/guides/using_black_with_other_tools.md b/docs/guides/using_black_with_other_tools.md
index 4b22f670fe100ea27f4b67b9fbbf2b99e9446fab..2b3855f7ef01afb8494dd64216e9515a5c53446c 100644 (file)
--- a/docs/guides/using_black_with_other_tools.md
+++ b/docs/guides/using_black_with_other_tools.md
@@ -13,7 +13,7 @@ tools out there.
 tools, using **their** supported file formats.
 
 Compatible configuration files can be
 tools, using **their** supported file formats.
 
 Compatible configuration files can be

-[found here](https://github.com/psf/black/blob/master/docs/compatible_configs/).
+[found here](https://github.com/psf/black/blob/main/docs/compatible_configs/).

 
 ### isort
 
 
 ### isort
 

diff --git a/docs/integrations/editors.md b/docs/integrations/editors.md
index 6a69e9e33fd8a81ea46e6dec995782ae85cfdf63..88176e1aecb937e08867d7caad94d00b310431f3 100644 (file)
--- a/docs/integrations/editors.md
+++ b/docs/integrations/editors.md
@@ -166,7 +166,7 @@ automatically installs _Black_. You can upgrade it later by calling `:BlackUpgra
 restarting Vim.
 
 If you need to do anything special to make your virtualenv work and install _Black_ (for
 restarting Vim.
 
 If you need to do anything special to make your virtualenv work and install _Black_ (for

-example you want to run a version from master), create a virtualenv manually and point
+example you want to run a version from main), create a virtualenv manually and point

 `g:black_virtualenv` to it. The plugin will use it.
 
 To run _Black_ on save, add the following line to `.vimrc` or `init.vim`:
 `g:black_virtualenv` to it. The plugin will use it.
 
 To run _Black_ on save, add the following line to `.vimrc` or `init.vim`:

diff --git a/gallery/gallery.py b/gallery/gallery.py
index 6b42ec3a6d490c2c0604f397110e449a74dbd180..3df05c1a722b637cb7b9c8abedbbcc907fc3a217 100755 (executable)
--- a/gallery/gallery.py
+++ b/gallery/gallery.py
@@ -74,7 +74,7 @@ def get_top_packages(days: Days) -> List[str]:
 def get_package_source(package: str, version: Optional[str]) -> str:
     if package == "cpython":
         if version is None:
 def get_package_source(package: str, version: Optional[str]) -> str:
     if package == "cpython":
         if version is None:

-            version = "master"
+            version = "main"

         return f"https://github.com/python/cpython/archive/{version}.zip"
     elif package == "pypy":
         if version is None:
         return f"https://github.com/python/cpython/archive/{version}.zip"
     elif package == "pypy":
         if version is None:


@@ -248,9 +248,9 @@ def format_repos(repos: Tuple[Path, ...], options: Namespace) -> None:
                 black_version=black_version,
                 input_directory=options.input,
             )
                 black_version=black_version,
                 input_directory=options.input,
             )

-        git_switch_branch("master", repo=repo)
+        git_switch_branch("main", repo=repo)

 
 

-    git_switch_branch("master", repo=options.black_repo)
+    git_switch_branch("main", repo=options.black_repo)

 
 
 def main() -> None:
 
 
 def main() -> None:


@@ -296,7 +296,7 @@ def main() -> None:
         type=Path,
         help="Output directory to download and put result artifacts.",
     )
         type=Path,
         help="Output directory to download and put result artifacts.",
     )

-    parser.add_argument("versions", nargs="*", default=("master",), help="")
+    parser.add_argument("versions", nargs="*", default=("main",), help="")

 
     options = parser.parse_args()
     repos = init_repos(options)
 
     options = parser.parse_args()
     repos = init_repos(options)

diff --git a/setup.py b/setup.py
index af93d0f453a1b26edffea070d86c72e73d7c35dc..3dc52b26e81acad365a0ea866ac111c27837b958 100644 (file)
--- a/setup.py
+++ b/setup.py
@@ -58,7 +58,7 @@ setup(
     author="Łukasz Langa",
     author_email="lukasz@langa.pl",
     url="https://github.com/psf/black",
     author="Łukasz Langa",
     author_email="lukasz@langa.pl",
     url="https://github.com/psf/black",

-    project_urls={"Changelog": "https://github.com/psf/black/blob/master/CHANGES.md"},
+    project_urls={"Changelog": "https://github.com/psf/black/blob/main/CHANGES.md"},

     license="MIT",
     py_modules=["_black_version"],
     ext_modules=ext_modules,
     license="MIT",
     py_modules=["_black_version"],
     ext_modules=ext_modules,