From 09aeddd709eb0d92468593e7fbba5a8ba4ed1a0e Mon Sep 17 00:00:00 2001 From: cosmicBboy Date: Tue, 1 Nov 2022 19:57:35 -0400 Subject: [PATCH] rename master to main --- .github/CONTRIBUTING.md | 106 ++++++++++++------------ .github/workflows/ci-tests.yml | 4 +- README.md | 8 +- docs/source/conf.py | 4 +- docs/source/index.rst | 12 +-- scripts/generate_pip_deps_from_conda.py | 2 +- 6 files changed, 68 insertions(+), 68 deletions(-) diff --git a/.github/CONTRIBUTING.md b/.github/CONTRIBUTING.md index 6afa49ff3..d84793436 100644 --- a/.github/CONTRIBUTING.md +++ b/.github/CONTRIBUTING.md @@ -178,15 +178,15 @@ onto the appropriate branch: #### Bugfixes - branch naming convention: `bugfix/` or `bugfix/` -- pull request to: `dev` +- pull request to: `main` #### Documentation - branch naming convention: `docs/` or `docs/` -- pull request to: `release/x.x.x` branch if specified in the issue milestone, otherwise `dev` +- pull request to: `release/x.x.x` branch if specified in the issue milestone, otherwise `main` #### Enhancements - branch naming convention: `feature/` or `feature/` -- pull request to: `release/x.x.x` branch if specified in the issue milestone, otherwise `dev` +- pull request to: `release/x.x.x` branch if specified in the issue milestone, otherwise `main` We will review your changes, and might ask you to make additional changes before it is finally ready to merge. However, once it's ready, we will merge @@ -201,55 +201,55 @@ did with `pandera`, or want to discuss a topic related to the project. ### Dataframe Schema Style Guides We have guidelines regarding dataframe and schema styles that are encouraged -for each pull request: - -- If specifying a single column DataFrame, this can be expressed as a one-liner: - - ```python - DataFrameSchema({"col1": Column(...)}) - ``` - -- If specifying one column with multiple lines, or multiple columns: - - ```python - DataFrameSchema( - { - "col1": Column( - int, - checks=[ - Check(...), - Check(...), - ] - ), - } - ) - ``` - -- If specifying columns with additional arguments that fit in one line: - - ```python - DataFrameSchema( - {"a": Column(int, nullable=True)}, - strict=True - ) - ``` - -- If specifying columns with additional arguments that don't fit in one line: - ```python - DataFrameSchema( - { - "a": Column( - int, - nullable=True, - coerce=True, - ... - ), - "b": Column( - ..., - ) - }, - strict=True) - ``` +for each pull request. + +If specifying a single column DataFrame, this can be expressed as a one-liner: + +```python +DataFrameSchema({"col1": Column(...)}) +``` + +If specifying one column with multiple lines, or multiple columns: + +```python +DataFrameSchema( + { + "col1": Column( + int, + checks=[ + Check(...), + Check(...), + ] + ), + } +) +``` + +If specifying columns with additional arguments that fit in one line: + +```python +DataFrameSchema( + {"a": Column(int, nullable=True)}, + strict=True +) +``` + +If specifying columns with additional arguments that don't fit in one line: +```python +DataFrameSchema( + { + "a": Column( + int, + nullable=True, + coerce=True, + ... + ), + "b": Column( + ..., + ) + }, + strict=True) +``` ## Deprecation policy @@ -259,4 +259,4 @@ This project adopts a rolling policy regarding the minimum supported version of * **NumPy**: 24 months * **Pandas**: 18 months -This means the latest minor (X.Y) version from N months prior. Patch versions (x.y.Z) are not pinned, and only the latest available at the moment of publishing the xarray release is guaranteed to work. +This means the latest minor (X.Y) version from N months prior. Patch versions (x.y.Z) are not pinned, and only the latest available at the moment of publishing the release is guaranteed to work. diff --git a/.github/workflows/ci-tests.yml b/.github/workflows/ci-tests.yml index 5d372f848..d3f3a605d 100644 --- a/.github/workflows/ci-tests.yml +++ b/.github/workflows/ci-tests.yml @@ -2,13 +2,13 @@ name: CI Tests on: push: branches: - - master + - main - dev - bugfix - "release/*" pull_request: branches: - - master + - main - dev - bugfix - "release/*" diff --git a/README.md b/README.md index e5ff88cbd..e97ed8f3d 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,5 @@
-
+
@@ -10,14 +10,14 @@ correctness.*
-[![CI Build](https://github.com/pandera-dev/pandera/workflows/CI%20Tests/badge.svg?branch=master)](https://github.com/pandera-dev/pandera/actions?query=workflow%3A%22CI+Tests%22+branch%3Amaster) +[![CI Build](https://github.com/pandera-dev/pandera/workflows/CI%20Tests/badge.svg?branch=main)](https://github.com/pandera-dev/pandera/actions?query=workflow%3A%22CI+Tests%22+branch%3Amain) [![Documentation Status](https://readthedocs.org/projects/pandera/badge/?version=stable)](https://pandera.readthedocs.io/en/stable/?badge=stable) [![PyPI version shields.io](https://img.shields.io/pypi/v/pandera.svg)](https://pypi.org/project/pandera/) [![PyPI license](https://img.shields.io/pypi/l/pandera.svg)](https://pypi.python.org/pypi/) [![pyOpenSci](https://tinyurl.com/y22nb8up)](https://github.com/pyOpenSci/software-review/issues/12) [![Project Status: Active – The project has reached a stable, usable state and is being actively developed.](https://www.repostatus.org/badges/latest/active.svg)](https://www.repostatus.org/#active) [![Documentation Status](https://readthedocs.org/projects/pandera/badge/?version=latest)](https://pandera.readthedocs.io/en/latest/?badge=latest) -[![codecov](https://codecov.io/gh/unionai-oss/pandera/branch/master/graph/badge.svg)](https://codecov.io/gh/pandera-dev/pandera) +[![codecov](https://codecov.io/gh/unionai-oss/pandera/branch/main/graph/badge.svg)](https://codecov.io/gh/pandera-dev/pandera) [![PyPI pyversions](https://img.shields.io/pypi/pyversions/pandera.svg)](https://pypi.python.org/pypi/pandera/) [![DOI](https://zenodo.org/badge/DOI/10.5281/zenodo.3385265.svg)](https://doi.org/10.5281/zenodo.3385265) [![asv](http://img.shields.io/badge/benchmarked%20by-asv-green.svg?style=flat)](https://pandera-dev.github.io/pandera-asv-logs/) @@ -202,7 +202,7 @@ All contributions, bug reports, bug fixes, documentation improvements, enhancements and ideas are welcome. A detailed overview on how to contribute can be found in the -[contributing guide](https://github.com/pandera-dev/pandera/blob/master/.github/CONTRIBUTING.md) +[contributing guide](https://github.com/pandera-dev/pandera/blob/main/.github/CONTRIBUTING.md) on GitHub. ## Issues diff --git a/docs/source/conf.py b/docs/source/conf.py index bc2b8b1d3..074e67396 100644 --- a/docs/source/conf.py +++ b/docs/source/conf.py @@ -144,7 +144,7 @@ "color-api-highlight-on-target": "#e5fff5", }, "source_repository": "https://github.com/pandera-dev/pandera", - "source_branch": "master", + "source_branch": "main", "source_directory": "docs/source/", } @@ -254,7 +254,7 @@ def linkcode_resolve(domain, info): except subprocess.CalledProcessError: tag = None - if tag != "master": + if tag != "main": tag = ( subprocess.check_output(["git", "rev-parse", "HEAD"]) .decode("utf-8") diff --git a/docs/source/index.rst b/docs/source/index.rst index efd8389ba..da7d5e2c7 100644 --- a/docs/source/index.rst +++ b/docs/source/index.rst @@ -1,4 +1,4 @@ -.. pandera documentation master file +.. pandera documentation entrypoint A Statistical Data Testing Toolkit ======================================= @@ -7,8 +7,8 @@ A Statistical Data Testing Toolkit correctness.* -.. image:: https://github.com/pandera-dev/pandera/workflows/CI%20Tests/badge.svg?branch=master - :target: https://github.com/pandera-dev/pandera/actions?query=workflow%3A%22CI+Tests%22+branch%3Amaster +.. image:: https://github.com/pandera-dev/pandera/workflows/CI%20Tests/badge.svg?branch=main + :target: https://github.com/pandera-dev/pandera/actions?query=workflow%3A%22CI+Tests%22+branch%3Amain :alt: CI Build .. image:: https://readthedocs.org/projects/pandera/badge/?version=stable @@ -35,7 +35,7 @@ correctness.* :target: https://pandera.readthedocs.io/en/stable/?badge=latest :alt: Documentation Latest Status -.. image:: https://codecov.io/gh/unionai-oss/pandera/branch/master/graph/badge.svg +.. image:: https://codecov.io/gh/unionai-oss/pandera/branch/main/graph/badge.svg :target: https://codecov.io/gh/unionai-oss/pandera :alt: Code Coverage @@ -322,7 +322,7 @@ enhancements and ideas are welcome. A detailed overview on how to contribute can be found in the `contributing -guide `__ +guide `__ on GitHub. Issues @@ -414,7 +414,7 @@ Software Package License and Credits ------------------- -``pandera`` is licensed under the `MIT license `_. +``pandera`` is licensed under the `MIT license `_. and is written and maintained by Niels Bantilan (niels@pandera.ci) diff --git a/scripts/generate_pip_deps_from_conda.py b/scripts/generate_pip_deps_from_conda.py index 716e2de21..1280a09bb 100755 --- a/scripts/generate_pip_deps_from_conda.py +++ b/scripts/generate_pip_deps_from_conda.py @@ -1,7 +1,7 @@ #!/usr/bin/env python # This script is a modified copy of generate_pip_deps_from_conda.py from # pandas and is distributed under the terms of the BSD 3 License that can be -# found at: https://github.com/pandas-dev/pandas/blob/master/LICENSE +# found at: https://github.com/pandas-dev/pandas/blob/main/LICENSE """ Convert the conda environment.yml to the pip requirements-dev.txt, or check that they have the same packages (for the CI)