From 06ccb88bf2bd35a4dc5d591bb296b5b299d07323 Mon Sep 17 00:00:00 2001 From: Panagiotis Vasilopoulos Date: Sun, 9 May 2021 21:50:17 +0000 Subject: [PATCH] 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> --- .flake8 | 2 +- .github/ISSUE_TEMPLATE/bug_report.md | 8 ++++---- CHANGES.md | 4 ++++ README.md | 6 +++--- docs/contributing/the_basics.md | 2 +- docs/guides/using_black_with_other_tools.md | 2 +- docs/integrations/editors.md | 2 +- gallery/gallery.py | 8 ++++---- setup.py | 2 +- 9 files changed, 20 insertions(+), 16 deletions(-) diff --git a/.flake8 b/.flake8 index 656c0df..68d1501 100644 --- 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 -# 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 diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md index 3b59906..c6c80be 100644 --- 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):** -- Version: \[e.g. master\] +- Version: \[e.g. main\] - 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 , which will - use the latest master branch. +1. Use the online formatter at , 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; diff --git a/CHANGES.md b/CHANGES.md index 9b15592..32c2d8d 100644 --- a/CHANGES.md +++ b/CHANGES.md @@ -8,6 +8,10 @@ ### 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) diff --git a/README.md b/README.md index ceccbb7..beb8069 100644 --- 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)

The Uncompromising Code Formatter

@@ -6,8 +6,8 @@ Actions Status Actions Status Documentation Status -Coverage Status -License: MIT +Coverage Status +License: MIT PyPI Downloads conda-forge diff --git a/docs/contributing/the_basics.md b/docs/contributing/the_basics.md index 461bff9..d36b17e 100644 --- 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 -[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 diff --git a/docs/guides/using_black_with_other_tools.md b/docs/guides/using_black_with_other_tools.md index 4b22f67..2b3855f 100644 --- 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 -[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 diff --git a/docs/integrations/editors.md b/docs/integrations/editors.md index 6a69e9e..88176e1 100644 --- 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 -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`: diff --git a/gallery/gallery.py b/gallery/gallery.py index 6b42ec3..3df05c1 100755 --- 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: - version = "master" + version = "main" 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, ) - 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: @@ -296,7 +296,7 @@ def main() -> None: 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) diff --git a/setup.py b/setup.py index af93d0f..3dc52b2 100644 --- 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", - 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, -- 2.39.2