From 72a361c68731212d8aa042f4c73d5070aa110a9a Mon Sep 17 00:00:00 2001 From: Jon Mease Date: Fri, 28 Jul 2023 03:05:45 -0400 Subject: [PATCH] master -> main in documentations, README, etc. (#3126) --- CONTRIBUTING.md | 2 +- README.md | 6 +++--- RELEASING.md | 10 +++++----- doc/getting_started/installation.rst | 4 ++-- doc/user_guide/internals.rst | 2 +- 5 files changed, 12 insertions(+), 12 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index a71e92a2f..8108a39cf 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -43,7 +43,7 @@ which you can find in `pyproject.toml` (`[project.optional-dependencies]/dev`) Once your local environment is up-to-date, you can create a new git branch which will contain your contribution -(always create a new branch instead of making changes to the master branch): +(always create a new branch instead of making changes to the main branch): ```cmd git switch -c diff --git a/README.md b/README.md index 0e3ab32d7..23fea0125 100644 --- a/README.md +++ b/README.md @@ -42,7 +42,7 @@ alt.Chart(cars).mark_point().encode( ) ``` -![Vega-Altair Visualization](https://raw.githubusercontent.com/altair-viz/altair/master/images/cars.png) +![Vega-Altair Visualization](https://raw.githubusercontent.com/altair-viz/altair/main/images/cars.png) One of the unique features of Vega-Altair, inherited from Vega-Lite, is a declarative grammar of not just visualization, but _interaction_. With a few modifications to the example above we can create a linked histogram that is filtered based on a selection of the scatter plot. @@ -74,7 +74,7 @@ bars = alt.Chart(source).mark_bar().encode( points & bars ``` -![Vega-Altair Visualization Gif](https://raw.githubusercontent.com/altair-viz/altair/master/images/cars_scatter_bar.gif) +![Vega-Altair Visualization Gif](https://raw.githubusercontent.com/altair-viz/altair/main/images/cars_scatter_bar.gif) ## Features * Carefully-designed, declarative Python API. @@ -114,7 +114,7 @@ hatch run test ``` For information on how to contribute your developments back to the Vega-Altair repository, see -[`CONTRIBUTING.md`](https://github.com/altair-viz/altair/blob/master/CONTRIBUTING.md) +[`CONTRIBUTING.md`](https://github.com/altair-viz/altair/blob/main/CONTRIBUTING.md) ## Citing Vega-Altair [![JOSS Paper](https://joss.theoj.org/papers/10.21105/joss.01057/status.svg)](https://joss.theoj.org/papers/10.21105/joss.01057) diff --git a/RELEASING.md b/RELEASING.md index 88029733c..f90fb82af 100644 --- a/RELEASING.md +++ b/RELEASING.md @@ -4,7 +4,7 @@ 2. Make certain your branch is in sync with head: - git pull upstream master + git pull upstream main 3. Do a clean doc build: @@ -28,11 +28,11 @@ - URLs in ``doc/conf.py`` - versions in ``altair/vegalite/v5/display.py`` -7. Commit change and push to master: +7. Commit change and push to main: git add . -u git commit -m "MAINT: bump version to 5.0.0" - git push upstream master + git push upstream main 8. Tag the release: @@ -69,11 +69,11 @@ Backward-Incompatible Changes ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -14. Commit change and push to master: +14. Commit change and push to main: git add . -u git commit -m "MAINT: bump version to 5.1.0dev" - git push upstream master + git push upstream main 15. Double-check that a conda-forge pull request is generated from the updated pip package by the conda-forge bot (may take up to ~an hour): diff --git a/doc/getting_started/installation.rst b/doc/getting_started/installation.rst index 06078b322..8de3b9775 100644 --- a/doc/getting_started/installation.rst +++ b/doc/getting_started/installation.rst @@ -27,7 +27,7 @@ Development Installation The `Altair source repository`_ is available on GitHub. Once you have cloned the repository and installed all the above dependencies, run the following command -from the root of the repository to install the master version of Altair: +from the root of the repository to install the main version of Altair: .. code-block:: bash @@ -46,7 +46,7 @@ development version directly from GitHub using: pip install -e git+https://github.com/altair-viz/altair.git -Please see `CONTRIBUTING.md `_ +Please see `CONTRIBUTING.md `_ for details on how to contribute to the Altair project. .. _conda: https://docs.conda.io/ diff --git a/doc/user_guide/internals.rst b/doc/user_guide/internals.rst index d7187db44..831c29cc3 100644 --- a/doc/user_guide/internals.rst +++ b/doc/user_guide/internals.rst @@ -110,7 +110,7 @@ Altair's python object structure and Vega-Lite's schema definition structure. One of the nice features of Altair is that this low-level object hierarchy is not constructed by hand, but rather *programmatically generated* from the Vega-Lite schema, using the ``generate_schema_wrapper.py`` script that you can find in -`Altair's repository `_. +`Altair's repository `_. This auto-generation of code propagates descriptions from the vega-lite schema into the Python class docstrings, from which the `API Reference `_