diff --git a/.github/ISSUE_TEMPLATE/feature_request.yaml b/.github/ISSUE_TEMPLATE/feature_request.yaml index f837eb1ca5bb7..6e6cd78ace11d 100644 --- a/.github/ISSUE_TEMPLATE/feature_request.yaml +++ b/.github/ISSUE_TEMPLATE/feature_request.yaml @@ -68,5 +68,5 @@ body: attributes: label: Additional Context description: > - Please provide any relevant Github issues, code examples or references that help describe and support + Please provide any relevant GitHub issues, code examples or references that help describe and support the feature request. diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md index 876e5e2cfbb1e..8eca91c692710 100644 --- a/.github/PULL_REQUEST_TEMPLATE.md +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -1,4 +1,4 @@ -- [ ] closes #xxxx (Replace xxxx with the Github issue number) +- [ ] closes #xxxx (Replace xxxx with the GitHub issue number) - [ ] [Tests added and passed](https://pandas.pydata.org/pandas-docs/dev/development/contributing_codebase.html#writing-tests) if fixing a bug or adding a new feature - [ ] All [code checks passed](https://pandas.pydata.org/pandas-docs/dev/development/contributing_codebase.html#pre-commit). - [ ] Added [type annotations](https://pandas.pydata.org/pandas-docs/dev/development/contributing_codebase.html#type-hints) to new arguments/methods/functions. diff --git a/.github/workflows/macos-windows.yml b/.github/workflows/macos-windows.yml index 8b3d69943bd9d..63c065fa3d701 100644 --- a/.github/workflows/macos-windows.yml +++ b/.github/workflows/macos-windows.yml @@ -1,4 +1,4 @@ -name: Windows-MacOS +name: Windows-macOS on: push: diff --git a/.github/workflows/python-dev.yml b/.github/workflows/python-dev.yml index 8b97c3821efe5..659f39c4c06e6 100644 --- a/.github/workflows/python-dev.yml +++ b/.github/workflows/python-dev.yml @@ -3,7 +3,7 @@ # # In general, this file will remain frozen(present, but not running) until: # - The next unreleased Python version has released beta 1 -# - This version should be available on Github Actions. +# - This version should be available on GitHub Actions. # - Our required build/runtime dependencies(numpy, pytz, Cython, python-dateutil) # support that unreleased Python version. # To unfreeze, comment out the ``if: false`` condition, and make sure you update diff --git a/.github/workflows/wheels.yml b/.github/workflows/wheels.yml index ceba2503de569..218d95229e93a 100644 --- a/.github/workflows/wheels.yml +++ b/.github/workflows/wheels.yml @@ -44,7 +44,7 @@ jobs: # Ensure that a wheel builder finishes even if another fails fail-fast: false matrix: - # Github Actions doesn't support pairing matrix values together, let's improvise + # GitHub Actions doesn't support pairing matrix values together, let's improvise # https://github.com/github/feedback/discussions/7835#discussioncomment-1769026 buildplat: - [ubuntu-20.04, manylinux_x86_64] diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml index 8d1d45a1f0909..d41d091d03bd7 100644 --- a/.pre-commit-config.yaml +++ b/.pre-commit-config.yaml @@ -251,7 +251,7 @@ repos: files: ^(ci/deps/actions-.*-minimum_versions\.yaml|pandas/compat/_optional\.py)$ - id: validate-errors-locations name: Validate errors locations - description: Validate errors are in approriate locations. + description: Validate errors are in appropriate locations. entry: python scripts/validate_exception_location.py language: python files: ^pandas/ diff --git a/doc/source/development/contributing_codebase.rst b/doc/source/development/contributing_codebase.rst index c60edd0d1c2b9..82d29f33ac6d6 100644 --- a/doc/source/development/contributing_codebase.rst +++ b/doc/source/development/contributing_codebase.rst @@ -651,7 +651,7 @@ Example ^^^^^^^ Here is an example of a self-contained set of tests in a file ``pandas/tests/test_cool_feature.py`` -that illustrate multiple features that we like to use. Please remember to add the Github Issue Number +that illustrate multiple features that we like to use. Please remember to add the GitHub Issue Number as a comment to a new test. .. code-block:: python diff --git a/doc/source/development/maintaining.rst b/doc/source/development/maintaining.rst index e12f4abda385c..df557585c6156 100644 --- a/doc/source/development/maintaining.rst +++ b/doc/source/development/maintaining.rst @@ -210,15 +210,15 @@ pandas supports point releases (e.g. ``1.4.3``) that aim to: * e.g. If a feature worked in ``1.2`` and stopped working since ``1.3``, a fix can be applied in ``1.4.3``. -Since pandas minor releases are based on Github branches (e.g. point release of ``1.4`` are based off the ``1.4.x`` branch), +Since pandas minor releases are based on GitHub branches (e.g. point release of ``1.4`` are based off the ``1.4.x`` branch), "backporting" means merging a pull request fix to the ``main`` branch and correct minor branch associated with the next point release. -By default, if a pull request is assigned to the next point release milestone within the Github interface, +By default, if a pull request is assigned to the next point release milestone within the GitHub interface, the backporting process should happen automatically by the ``@meeseeksdev`` bot once the pull request is merged. A new pull request will be made backporting the pull request to the correct version branch. Sometimes due to merge conflicts, a manual pull request will need to be made addressing the code conflict. -If the bot does not automatically start the backporting process, you can also write a Github comment in the merged pull request +If the bot does not automatically start the backporting process, you can also write a GitHub comment in the merged pull request to trigger the backport:: @meeseeksdev backport version-branch @@ -271,14 +271,14 @@ being helpful on the issue tracker. The required steps for adding a maintainer are: 1. Contact the contributor and ask their interest to join. -2. Add the contributor to the appropriate `Github Team `_ if accepted the invitation. +2. Add the contributor to the appropriate `GitHub Team `_ if accepted the invitation. * ``pandas-core`` is for core team members * ``pandas-triage`` is for pandas triage members 3. Add the contributor to the pandas Google group. -4. Create a pull request to add the contributor's Github handle to ``pandas-dev/pandas/web/pandas/config.yml``. -5. Create a pull request to add the contributor's name/Github handle to the `governance document `_. +4. Create a pull request to add the contributor's GitHub handle to ``pandas-dev/pandas/web/pandas/config.yml``. +5. Create a pull request to add the contributor's name/GitHub handle to the `governance document `_. The current list of core-team members is at https://github.com/pandas-dev/pandas-governance/blob/master/people.md @@ -328,7 +328,7 @@ The machine can be configured with the `Ansible `_ +`GitHub network dependents for pandas `_ or `search pypi for pandas `_. We'd like to make it easier for users to find these projects, if you know of other @@ -599,4 +599,4 @@ Install pandas-stubs to enable basic type coverage of pandas API. Learn more by reading through :issue:`14468`, :issue:`26766`, :issue:`28142`. -See installation and usage instructions on the `github page `__. +See installation and usage instructions on the `GitHub page `__. diff --git a/doc/source/getting_started/overview.rst b/doc/source/getting_started/overview.rst index 320d2da01418c..8c1be6d9a08c1 100644 --- a/doc/source/getting_started/overview.rst +++ b/doc/source/getting_started/overview.rst @@ -133,7 +133,7 @@ untouched. In general we like to **favor immutability** where sensible. Getting support --------------- -The first stop for pandas issues and ideas is the `Github Issue Tracker +The first stop for pandas issues and ideas is the `GitHub Issue Tracker `__. If you have a general question, pandas community experts can answer through `Stack Overflow `__. diff --git a/doc/source/whatsnew/v1.5.0.rst b/doc/source/whatsnew/v1.5.0.rst index 7f968694693f9..3d67f5c4818ad 100644 --- a/doc/source/whatsnew/v1.5.0.rst +++ b/doc/source/whatsnew/v1.5.0.rst @@ -654,7 +654,7 @@ Deprecations In the next major version release, 2.0, several larger API changes are being considered without a formal deprecation such as making the standard library `zoneinfo `_ the default timezone implementation instead of ``pytz``, having the :class:`Index` support all data types instead of having multiple subclasses (:class:`CategoricalIndex`, :class:`Int64Index`, etc.), and more. - The changes under consideration are logged in `this Github issue `_, and any + The changes under consideration are logged in `this GitHub issue `_, and any feedback or concerns are welcome. .. _whatsnew_150.deprecations.int_slicing_series: diff --git a/doc/sphinxext/announce.py b/doc/sphinxext/announce.py index b0b430ed6a866..94cbc852a4a38 100755 --- a/doc/sphinxext/announce.py +++ b/doc/sphinxext/announce.py @@ -3,7 +3,7 @@ Script to generate contributor and pull request lists This script generates contributor and pull request lists for release -announcements using Github v3 protocol. Use requires an authentication token in +announcements using GitHub v3 protocol. Use requires an authentication token in order to have sufficient bandwidth, you can get one following the directions at `_ Don't add any scope, as the default is read access to public information. The @@ -112,7 +112,7 @@ def get_pull_requests(repo, revision_range): issues = re.findall("^.*\\(\\#(\\d+)\\)$", commits, re.M) prnums.extend(int(s) for s in issues) - # get PR data from github repo + # get PR data from GitHub repo prnums.sort() prs = [repo.get_pull(n) for n in prnums] return prs diff --git a/pandas/_version.py b/pandas/_version.py index a5eec4222ca41..25142781299b4 100644 --- a/pandas/_version.py +++ b/pandas/_version.py @@ -1,5 +1,5 @@ # This file helps to compute a version number in source trees obtained from -# git-archive tarball (such as those provided by githubs download-from-tag +# git-archive tarball (such as those provided by GitHub's download-from-tag # feature). Distribution tarballs (built by setup.py sdist) and build # directories (produced by setup.py build) will contain a much shorter file # that just contains the computed version number. diff --git a/pandas/core/internals/api.py b/pandas/core/internals/api.py index 371f1e2443b36..5e03621db2ad7 100644 --- a/pandas/core/internals/api.py +++ b/pandas/core/internals/api.py @@ -83,7 +83,7 @@ def make_block( def maybe_infer_ndim(values, placement: BlockPlacement, ndim: int | None) -> int: """ - If `ndim` is not provided, infer it from placment and values. + If `ndim` is not provided, infer it from placement and values. """ if ndim is None: # GH#38134 Block constructor now assumes ndim is not None diff --git a/pandas/core/missing.py b/pandas/core/missing.py index 203260f99e547..6ad8403c62720 100644 --- a/pandas/core/missing.py +++ b/pandas/core/missing.py @@ -418,7 +418,7 @@ def _interpolate_1d( # For example if limit_direction='forward' then preserve_nans will # contain indices of NaNs at the beginning of the series, and NaNs that - # are more than'limit' away from the prior non-NaN. + # are more than 'limit' away from the prior non-NaN. # set preserve_nans based on direction using _interp_limit preserve_nans: list | set diff --git a/pandas/io/clipboard/__init__.py b/pandas/io/clipboard/__init__.py index 03599497f8d03..8974c7f42bb3c 100644 --- a/pandas/io/clipboard/__init__.py +++ b/pandas/io/clipboard/__init__.py @@ -538,7 +538,7 @@ def determine_clipboard(): if which("wslconfig.exe"): return init_wsl_clipboard() - # Setup for the MAC OS X platform: + # Setup for the macOS platform: if os.name == "mac" or platform.system() == "Darwin": try: import AppKit @@ -587,7 +587,7 @@ def set_clipboard(clipboard): the copy() and paste() functions interact with the operating system to implement the copy/paste feature. The clipboard parameter must be one of: - pbcopy - - pbobjc (default on Mac OS X) + - pyobjc (default on macOS) - qt - xclip - xsel diff --git a/pandas/tests/extension/json/array.py b/pandas/tests/extension/json/array.py index 125a0aee2089d..f7de31e58b104 100644 --- a/pandas/tests/extension/json/array.py +++ b/pandas/tests/extension/json/array.py @@ -203,7 +203,7 @@ def astype(self, dtype, copy=True): return self.copy() return self elif isinstance(dtype, StringDtype): - value = self.astype(str) # numpy doesn'y like nested dicts + value = self.astype(str) # numpy doesn't like nested dicts return dtype.construct_array_type()._from_sequence(value, copy=False) return np.array([dict(x) for x in self], dtype=dtype, copy=copy) diff --git a/pandas/tests/io/conftest.py b/pandas/tests/io/conftest.py index 522d25205eeb0..2fac7ca0b3e00 100644 --- a/pandas/tests/io/conftest.py +++ b/pandas/tests/io/conftest.py @@ -69,14 +69,14 @@ def s3_base(worker_id): os.environ.setdefault("AWS_SECRET_ACCESS_KEY", "foobar_secret") if is_ci_environment(): if is_platform_arm() or is_platform_mac() or is_platform_windows(): - # NOT RUN on Windows/MacOS/ARM, only Ubuntu + # NOT RUN on Windows/macOS/ARM, only Ubuntu # - subprocess in CI can cause timeouts - # - Github Actions do not support + # - GitHub Actions do not support # container services for the above OSs # - CircleCI will probably hit the Docker rate pull limit pytest.skip( "S3 tests do not have a corresponding service in " - "Windows, MacOS or ARM platforms" + "Windows, macOS or ARM platforms" ) else: yield "http://localhost:5000" diff --git a/pandas/tests/window/test_numba.py b/pandas/tests/window/test_numba.py index 89e00af270a02..1c78a186e9d37 100644 --- a/pandas/tests/window/test_numba.py +++ b/pandas/tests/window/test_numba.py @@ -22,7 +22,7 @@ is_ci_environment() and (is_platform_windows() or is_platform_mac()), reason="On GHA CI, Windows can fail with " "'Windows fatal exception: stack overflow' " - "and MacOS can timeout", + "and macOS can timeout", ) diff --git a/pandas/tests/window/test_online.py b/pandas/tests/window/test_online.py index cce46526884a6..8e632cf53fd9f 100644 --- a/pandas/tests/window/test_online.py +++ b/pandas/tests/window/test_online.py @@ -19,7 +19,7 @@ is_ci_environment() and (is_platform_windows() or is_platform_mac()), reason="On GHA CI, Windows can fail with " "'Windows fatal exception: stack overflow' " - "and MacOS can timeout", + "and macOS can timeout", ) diff --git a/pandas/tests/window/test_win_type.py b/pandas/tests/window/test_win_type.py index ba80ac19a6b6a..db03fa880085d 100644 --- a/pandas/tests/window/test_win_type.py +++ b/pandas/tests/window/test_win_type.py @@ -684,7 +684,7 @@ def test_cmov_window_special_linear_range(win_types_special, step): @td.skip_if_no_scipy def test_weighted_var_big_window_no_segfault(win_types, center): - # Github Issue #46772 + # GitHub Issue #46772 x = Series(0) result = x.rolling(window=16, center=center, win_type=win_types).var() expected = Series(np.NaN) diff --git a/versioneer.py b/versioneer.py index c98dbd83271d7..2ab269f9c3ea8 100644 --- a/versioneer.py +++ b/versioneer.py @@ -33,7 +33,7 @@ * a version-control system checkout (mostly used by developers) * a nightly tarball, produced by build automation -* a snapshot tarball, produced by a web-based VCS browser, like github's +* a snapshot tarball, produced by a web-based VCS browser, like GitHub's "tarball from tag" feature * a release tarball, produced by "setup.py sdist", distributed through PyPI @@ -161,7 +161,7 @@ ## Known Limitations Some situations are known to cause problems for Versioneer. This details the -most significant ones. More can be found on Github +most significant ones. More can be found on GitHub [issues page](https://github.com/python-versioneer/python-versioneer/issues). ### Subprojects @@ -421,7 +421,7 @@ def run_command(commands, args, cwd=None, verbose=False, hide_stderr=False, env= "git" ] = r''' # This file helps to compute a version number in source trees obtained from -# git-archive tarball (such as those provided by githubs download-from-tag +# git-archive tarball (such as those provided by GitHub's download-from-tag # feature). Distribution tarballs (built by setup.py sdist) and build # directories (produced by setup.py build) will contain a much shorter file # that just contains the computed version number. @@ -1466,7 +1466,7 @@ def get_versions(verbose=False): # extract version from first of: _version.py, VCS command (e.g. 'git # describe'), parentdir. This is meant to work for developers using a # source checkout, for users of a tarball created by 'setup.py sdist', - # and for users of a tarball/zipball created by 'git archive' or github's + # and for users of a tarball/zipball created by 'git archive' or GitHub's # download-from-tag feature or the equivalent in other VCSes. get_keywords_f = handlers.get("get_keywords") diff --git a/web/pandas/community/ecosystem.md b/web/pandas/community/ecosystem.md index 89d243555a358..861f3bd8e1ea7 100644 --- a/web/pandas/community/ecosystem.md +++ b/web/pandas/community/ecosystem.md @@ -399,7 +399,7 @@ Install pandas-stubs to enable basic type coverage of pandas API. Learn more by reading through these issues [14468](https://github.com/pandas-dev/pandas/issues/14468), [26766](https://github.com/pandas-dev/pandas/issues/26766), [28142](https://github.com/pandas-dev/pandas/issues/28142). -See installation and usage instructions on the [github page](https://github.com/VirtusLab/pandas-stubs). +See installation and usage instructions on the [GitHub page](https://github.com/VirtusLab/pandas-stubs). ### [Hamilton](https://github.com/stitchfix/hamilton) @@ -411,8 +411,8 @@ It prescibes an opinionated paradigm, that ensures all code is: * unit testable * integration testing friendly * documentation friendly -* transformation logic is reuseable, as it is decoupled from the context of where it is used. -* integrateable with runtime data quality checks. +* transformation logic is reusable, as it is decoupled from the context of where it is used. +* integratable with runtime data quality checks. This helps one to scale your pandas code base, at the same time, keeping maintenance costs low. diff --git a/web/pandas/getting_started.md b/web/pandas/getting_started.md index 84893db505908..8b5849892f4ae 100644 --- a/web/pandas/getting_started.md +++ b/web/pandas/getting_started.md @@ -29,7 +29,7 @@ the [advanced installation page]({{ base_url}}/docs/getting_started/install.html Detailed instructions on how to install Anaconda can be found in the [Anaconda documentation](https://docs.anaconda.com/anaconda/install/). -2. In the Anaconda prompt (or terminal in Linux or MacOS), start JupyterLab: +2. In the Anaconda prompt (or terminal in Linux or macOS), start JupyterLab: diff --git a/web/pandas_web.py b/web/pandas_web.py index 62539574543a9..d054e273cde5e 100755 --- a/web/pandas_web.py +++ b/web/pandas_web.py @@ -338,7 +338,7 @@ def main( Copy every file in the source directory to the target directory. For ``.md`` and ``.html`` files, render them with the context - before copyings them. ``.md`` files are transformed to HTML. + before copying them. ``.md`` files are transformed to HTML. """ config_fname = os.path.join(source_path, "config.yml") @@ -395,7 +395,7 @@ def main( action="store_true", help="do not fail if errors happen when fetching " "data from http sources, and those fail " - "(mostly useful to allow github quota errors " + "(mostly useful to allow GitHub quota errors " "when running the script locally)", ) args = parser.parse_args()