Skip to content

Commit cdd8454

Browse files
Guilherme Beltramininoatamir
Guilherme Beltramini
authored andcommitted
DOC: Fix typos and standardize spelling of "GitHub" and "macOS" (pandas-dev#49005)
1 parent 5793fc2 commit cdd8454

25 files changed

+42
-42
lines changed

.github/ISSUE_TEMPLATE/feature_request.yaml

+1-1
Original file line numberDiff line numberDiff line change
@@ -68,5 +68,5 @@ body:
6868
attributes:
6969
label: Additional Context
7070
description: >
71-
Please provide any relevant Github issues, code examples or references that help describe and support
71+
Please provide any relevant GitHub issues, code examples or references that help describe and support
7272
the feature request.

.github/PULL_REQUEST_TEMPLATE.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
- [ ] closes #xxxx (Replace xxxx with the Github issue number)
1+
- [ ] closes #xxxx (Replace xxxx with the GitHub issue number)
22
- [ ] [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
33
- [ ] All [code checks passed](https://pandas.pydata.org/pandas-docs/dev/development/contributing_codebase.html#pre-commit).
44
- [ ] Added [type annotations](https://pandas.pydata.org/pandas-docs/dev/development/contributing_codebase.html#type-hints) to new arguments/methods/functions.

.github/workflows/macos-windows.yml

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
name: Windows-MacOS
1+
name: Windows-macOS
22

33
on:
44
push:

.github/workflows/python-dev.yml

+1-1
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
#
44
# In general, this file will remain frozen(present, but not running) until:
55
# - The next unreleased Python version has released beta 1
6-
# - This version should be available on Github Actions.
6+
# - This version should be available on GitHub Actions.
77
# - Our required build/runtime dependencies(numpy, pytz, Cython, python-dateutil)
88
# support that unreleased Python version.
99
# To unfreeze, comment out the ``if: false`` condition, and make sure you update

.github/workflows/wheels.yml

+1-1
Original file line numberDiff line numberDiff line change
@@ -44,7 +44,7 @@ jobs:
4444
# Ensure that a wheel builder finishes even if another fails
4545
fail-fast: false
4646
matrix:
47-
# Github Actions doesn't support pairing matrix values together, let's improvise
47+
# GitHub Actions doesn't support pairing matrix values together, let's improvise
4848
# https://github.com/github/feedback/discussions/7835#discussioncomment-1769026
4949
buildplat:
5050
- [ubuntu-20.04, manylinux_x86_64]

.pre-commit-config.yaml

+1-1
Original file line numberDiff line numberDiff line change
@@ -251,7 +251,7 @@ repos:
251251
files: ^(ci/deps/actions-.*-minimum_versions\.yaml|pandas/compat/_optional\.py)$
252252
- id: validate-errors-locations
253253
name: Validate errors locations
254-
description: Validate errors are in approriate locations.
254+
description: Validate errors are in appropriate locations.
255255
entry: python scripts/validate_exception_location.py
256256
language: python
257257
files: ^pandas/

doc/source/development/contributing_codebase.rst

+1-1
Original file line numberDiff line numberDiff line change
@@ -651,7 +651,7 @@ Example
651651
^^^^^^^
652652

653653
Here is an example of a self-contained set of tests in a file ``pandas/tests/test_cool_feature.py``
654-
that illustrate multiple features that we like to use. Please remember to add the Github Issue Number
654+
that illustrate multiple features that we like to use. Please remember to add the GitHub Issue Number
655655
as a comment to a new test.
656656

657657
.. code-block:: python

doc/source/development/maintaining.rst

+7-7
Original file line numberDiff line numberDiff line change
@@ -210,15 +210,15 @@ pandas supports point releases (e.g. ``1.4.3``) that aim to:
210210

211211
* e.g. If a feature worked in ``1.2`` and stopped working since ``1.3``, a fix can be applied in ``1.4.3``.
212212

213-
Since pandas minor releases are based on Github branches (e.g. point release of ``1.4`` are based off the ``1.4.x`` branch),
213+
Since pandas minor releases are based on GitHub branches (e.g. point release of ``1.4`` are based off the ``1.4.x`` branch),
214214
"backporting" means merging a pull request fix to the ``main`` branch and correct minor branch associated with the next point release.
215215

216-
By default, if a pull request is assigned to the next point release milestone within the Github interface,
216+
By default, if a pull request is assigned to the next point release milestone within the GitHub interface,
217217
the backporting process should happen automatically by the ``@meeseeksdev`` bot once the pull request is merged.
218218
A new pull request will be made backporting the pull request to the correct version branch.
219219
Sometimes due to merge conflicts, a manual pull request will need to be made addressing the code conflict.
220220

221-
If the bot does not automatically start the backporting process, you can also write a Github comment in the merged pull request
221+
If the bot does not automatically start the backporting process, you can also write a GitHub comment in the merged pull request
222222
to trigger the backport::
223223

224224
@meeseeksdev backport version-branch
@@ -271,14 +271,14 @@ being helpful on the issue tracker.
271271
The required steps for adding a maintainer are:
272272

273273
1. Contact the contributor and ask their interest to join.
274-
2. Add the contributor to the appropriate `Github Team <https://github.com/orgs/pandas-dev/teams>`_ if accepted the invitation.
274+
2. Add the contributor to the appropriate `GitHub Team <https://github.com/orgs/pandas-dev/teams>`_ if accepted the invitation.
275275

276276
* ``pandas-core`` is for core team members
277277
* ``pandas-triage`` is for pandas triage members
278278

279279
3. Add the contributor to the pandas Google group.
280-
4. Create a pull request to add the contributor's Github handle to ``pandas-dev/pandas/web/pandas/config.yml``.
281-
5. Create a pull request to add the contributor's name/Github handle to the `governance document <https://github.com/pandas-dev/pandas-governance/blob/master/people.md>`_.
280+
4. Create a pull request to add the contributor's GitHub handle to ``pandas-dev/pandas/web/pandas/config.yml``.
281+
5. Create a pull request to add the contributor's name/GitHub handle to the `governance document <https://github.com/pandas-dev/pandas-governance/blob/master/people.md>`_.
282282

283283
The current list of core-team members is at
284284
https://github.com/pandas-dev/pandas-governance/blob/master/people.md
@@ -328,7 +328,7 @@ The machine can be configured with the `Ansible <http://docs.ansible.com/ansible
328328
Publishing
329329
``````````
330330

331-
The results are published to another Github repository, https://github.com/tomaugspurger/asv-collection.
331+
The results are published to another GitHub repository, https://github.com/tomaugspurger/asv-collection.
332332
Finally, we have a cron job on our docs server to pull from https://github.com/tomaugspurger/asv-collection, to serve them from ``/speed``.
333333
Ask Tom or Joris for access to the webserver.
334334

doc/source/ecosystem.rst

+2-2
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ development to remain focused around it's original requirements.
1919
This is an inexhaustive list of projects that build on pandas in order to provide
2020
tools in the PyData space. For a list of projects that depend on pandas,
2121
see the
22-
`Github network dependents for pandas <https://github.com/pandas-dev/pandas/network/dependents>`_
22+
`GitHub network dependents for pandas <https://github.com/pandas-dev/pandas/network/dependents>`_
2323
or `search pypi for pandas <https://pypi.org/search/?q=pandas>`_.
2424

2525
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.
599599

600600
Learn more by reading through :issue:`14468`, :issue:`26766`, :issue:`28142`.
601601

602-
See installation and usage instructions on the `github page <https://github.com/pandas-dev/pandas-stubs>`__.
602+
See installation and usage instructions on the `GitHub page <https://github.com/pandas-dev/pandas-stubs>`__.

doc/source/getting_started/overview.rst

+1-1
Original file line numberDiff line numberDiff line change
@@ -133,7 +133,7 @@ untouched. In general we like to **favor immutability** where sensible.
133133
Getting support
134134
---------------
135135

136-
The first stop for pandas issues and ideas is the `Github Issue Tracker
136+
The first stop for pandas issues and ideas is the `GitHub Issue Tracker
137137
<https://github.com/pandas-dev/pandas/issues>`__. If you have a general question,
138138
pandas community experts can answer through `Stack Overflow
139139
<https://stackoverflow.com/questions/tagged/pandas>`__.

doc/source/whatsnew/v1.5.0.rst

+1-1
Original file line numberDiff line numberDiff line change
@@ -654,7 +654,7 @@ Deprecations
654654
In the next major version release, 2.0, several larger API changes are being considered without a formal deprecation such as
655655
making the standard library `zoneinfo <https://docs.python.org/3/library/zoneinfo.html>`_ the default timezone implementation instead of ``pytz``,
656656
having the :class:`Index` support all data types instead of having multiple subclasses (:class:`CategoricalIndex`, :class:`Int64Index`, etc.), and more.
657-
The changes under consideration are logged in `this Github issue <https://github.com/pandas-dev/pandas/issues/44823>`_, and any
657+
The changes under consideration are logged in `this GitHub issue <https://github.com/pandas-dev/pandas/issues/44823>`_, and any
658658
feedback or concerns are welcome.
659659

660660
.. _whatsnew_150.deprecations.int_slicing_series:

doc/sphinxext/announce.py

+2-2
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
Script to generate contributor and pull request lists
44
55
This script generates contributor and pull request lists for release
6-
announcements using Github v3 protocol. Use requires an authentication token in
6+
announcements using GitHub v3 protocol. Use requires an authentication token in
77
order to have sufficient bandwidth, you can get one following the directions at
88
`<https://help.github.com/articles/creating-an-access-token-for-command-line-use/>_
99
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):
112112
issues = re.findall("^.*\\(\\#(\\d+)\\)$", commits, re.M)
113113
prnums.extend(int(s) for s in issues)
114114

115-
# get PR data from github repo
115+
# get PR data from GitHub repo
116116
prnums.sort()
117117
prs = [repo.get_pull(n) for n in prnums]
118118
return prs

pandas/_version.py

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
# This file helps to compute a version number in source trees obtained from
2-
# git-archive tarball (such as those provided by githubs download-from-tag
2+
# git-archive tarball (such as those provided by GitHub's download-from-tag
33
# feature). Distribution tarballs (built by setup.py sdist) and build
44
# directories (produced by setup.py build) will contain a much shorter file
55
# that just contains the computed version number.

pandas/core/internals/api.py

+1-1
Original file line numberDiff line numberDiff line change
@@ -83,7 +83,7 @@ def make_block(
8383

8484
def maybe_infer_ndim(values, placement: BlockPlacement, ndim: int | None) -> int:
8585
"""
86-
If `ndim` is not provided, infer it from placment and values.
86+
If `ndim` is not provided, infer it from placement and values.
8787
"""
8888
if ndim is None:
8989
# GH#38134 Block constructor now assumes ndim is not None

pandas/core/missing.py

+1-1
Original file line numberDiff line numberDiff line change
@@ -418,7 +418,7 @@ def _interpolate_1d(
418418

419419
# For example if limit_direction='forward' then preserve_nans will
420420
# contain indices of NaNs at the beginning of the series, and NaNs that
421-
# are more than'limit' away from the prior non-NaN.
421+
# are more than 'limit' away from the prior non-NaN.
422422

423423
# set preserve_nans based on direction using _interp_limit
424424
preserve_nans: list | set

pandas/io/clipboard/__init__.py

+2-2
Original file line numberDiff line numberDiff line change
@@ -538,7 +538,7 @@ def determine_clipboard():
538538
if which("wslconfig.exe"):
539539
return init_wsl_clipboard()
540540

541-
# Setup for the MAC OS X platform:
541+
# Setup for the macOS platform:
542542
if os.name == "mac" or platform.system() == "Darwin":
543543
try:
544544
import AppKit
@@ -587,7 +587,7 @@ def set_clipboard(clipboard):
587587
the copy() and paste() functions interact with the operating system to
588588
implement the copy/paste feature. The clipboard parameter must be one of:
589589
- pbcopy
590-
- pbobjc (default on Mac OS X)
590+
- pyobjc (default on macOS)
591591
- qt
592592
- xclip
593593
- xsel

pandas/tests/extension/json/array.py

+1-1
Original file line numberDiff line numberDiff line change
@@ -203,7 +203,7 @@ def astype(self, dtype, copy=True):
203203
return self.copy()
204204
return self
205205
elif isinstance(dtype, StringDtype):
206-
value = self.astype(str) # numpy doesn'y like nested dicts
206+
value = self.astype(str) # numpy doesn't like nested dicts
207207
return dtype.construct_array_type()._from_sequence(value, copy=False)
208208

209209
return np.array([dict(x) for x in self], dtype=dtype, copy=copy)

pandas/tests/io/conftest.py

+3-3
Original file line numberDiff line numberDiff line change
@@ -69,14 +69,14 @@ def s3_base(worker_id):
6969
os.environ.setdefault("AWS_SECRET_ACCESS_KEY", "foobar_secret")
7070
if is_ci_environment():
7171
if is_platform_arm() or is_platform_mac() or is_platform_windows():
72-
# NOT RUN on Windows/MacOS/ARM, only Ubuntu
72+
# NOT RUN on Windows/macOS/ARM, only Ubuntu
7373
# - subprocess in CI can cause timeouts
74-
# - Github Actions do not support
74+
# - GitHub Actions do not support
7575
# container services for the above OSs
7676
# - CircleCI will probably hit the Docker rate pull limit
7777
pytest.skip(
7878
"S3 tests do not have a corresponding service in "
79-
"Windows, MacOS or ARM platforms"
79+
"Windows, macOS or ARM platforms"
8080
)
8181
else:
8282
yield "http://localhost:5000"

pandas/tests/window/test_numba.py

+1-1
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@
2222
is_ci_environment() and (is_platform_windows() or is_platform_mac()),
2323
reason="On GHA CI, Windows can fail with "
2424
"'Windows fatal exception: stack overflow' "
25-
"and MacOS can timeout",
25+
"and macOS can timeout",
2626
)
2727

2828

pandas/tests/window/test_online.py

+1-1
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@
1919
is_ci_environment() and (is_platform_windows() or is_platform_mac()),
2020
reason="On GHA CI, Windows can fail with "
2121
"'Windows fatal exception: stack overflow' "
22-
"and MacOS can timeout",
22+
"and macOS can timeout",
2323
)
2424

2525

pandas/tests/window/test_win_type.py

+1-1
Original file line numberDiff line numberDiff line change
@@ -684,7 +684,7 @@ def test_cmov_window_special_linear_range(win_types_special, step):
684684

685685
@td.skip_if_no_scipy
686686
def test_weighted_var_big_window_no_segfault(win_types, center):
687-
# Github Issue #46772
687+
# GitHub Issue #46772
688688
x = Series(0)
689689
result = x.rolling(window=16, center=center, win_type=win_types).var()
690690
expected = Series(np.NaN)

versioneer.py

+4-4
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,7 @@
3333
3434
* a version-control system checkout (mostly used by developers)
3535
* a nightly tarball, produced by build automation
36-
* a snapshot tarball, produced by a web-based VCS browser, like github's
36+
* a snapshot tarball, produced by a web-based VCS browser, like GitHub's
3737
"tarball from tag" feature
3838
* a release tarball, produced by "setup.py sdist", distributed through PyPI
3939
@@ -161,7 +161,7 @@
161161
## Known Limitations
162162
163163
Some situations are known to cause problems for Versioneer. This details the
164-
most significant ones. More can be found on Github
164+
most significant ones. More can be found on GitHub
165165
[issues page](https://github.com/python-versioneer/python-versioneer/issues).
166166
167167
### Subprojects
@@ -421,7 +421,7 @@ def run_command(commands, args, cwd=None, verbose=False, hide_stderr=False, env=
421421
"git"
422422
] = r'''
423423
# This file helps to compute a version number in source trees obtained from
424-
# git-archive tarball (such as those provided by githubs download-from-tag
424+
# git-archive tarball (such as those provided by GitHub's download-from-tag
425425
# feature). Distribution tarballs (built by setup.py sdist) and build
426426
# directories (produced by setup.py build) will contain a much shorter file
427427
# that just contains the computed version number.
@@ -1466,7 +1466,7 @@ def get_versions(verbose=False):
14661466
# extract version from first of: _version.py, VCS command (e.g. 'git
14671467
# describe'), parentdir. This is meant to work for developers using a
14681468
# source checkout, for users of a tarball created by 'setup.py sdist',
1469-
# and for users of a tarball/zipball created by 'git archive' or github's
1469+
# and for users of a tarball/zipball created by 'git archive' or GitHub's
14701470
# download-from-tag feature or the equivalent in other VCSes.
14711471

14721472
get_keywords_f = handlers.get("get_keywords")

web/pandas/community/ecosystem.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -399,7 +399,7 @@ Install pandas-stubs to enable basic type coverage of pandas API.
399399
Learn more by reading through these issues [14468](https://github.com/pandas-dev/pandas/issues/14468),
400400
[26766](https://github.com/pandas-dev/pandas/issues/26766), [28142](https://github.com/pandas-dev/pandas/issues/28142).
401401

402-
See installation and usage instructions on the [github page](https://github.com/VirtusLab/pandas-stubs).
402+
See installation and usage instructions on the [GitHub page](https://github.com/VirtusLab/pandas-stubs).
403403

404404
### [Hamilton](https://github.com/stitchfix/hamilton)
405405

@@ -411,8 +411,8 @@ It prescibes an opinionated paradigm, that ensures all code is:
411411
* unit testable
412412
* integration testing friendly
413413
* documentation friendly
414-
* transformation logic is reuseable, as it is decoupled from the context of where it is used.
415-
* integrateable with runtime data quality checks.
414+
* transformation logic is reusable, as it is decoupled from the context of where it is used.
415+
* integratable with runtime data quality checks.
416416

417417
This helps one to scale your pandas code base, at the same time, keeping maintenance costs low.
418418

web/pandas/getting_started.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,7 @@ the [advanced installation page]({{ base_url}}/docs/getting_started/install.html
2929
Detailed instructions on how to install Anaconda can be found in the
3030
[Anaconda documentation](https://docs.anaconda.com/anaconda/install/).
3131

32-
2. In the Anaconda prompt (or terminal in Linux or MacOS), start JupyterLab:
32+
2. In the Anaconda prompt (or terminal in Linux or macOS), start JupyterLab:
3333

3434
<img class="img-fluid" alt="" src="{{ base_url }}/static/img/install/anaconda_prompt.png"/>
3535

web/pandas_web.py

+2-2
Original file line numberDiff line numberDiff line change
@@ -338,7 +338,7 @@ def main(
338338
Copy every file in the source directory to the target directory.
339339
340340
For ``.md`` and ``.html`` files, render them with the context
341-
before copyings them. ``.md`` files are transformed to HTML.
341+
before copying them. ``.md`` files are transformed to HTML.
342342
"""
343343
config_fname = os.path.join(source_path, "config.yml")
344344

@@ -395,7 +395,7 @@ def main(
395395
action="store_true",
396396
help="do not fail if errors happen when fetching "
397397
"data from http sources, and those fail "
398-
"(mostly useful to allow github quota errors "
398+
"(mostly useful to allow GitHub quota errors "
399399
"when running the script locally)",
400400
)
401401
args = parser.parse_args()

0 commit comments

Comments
 (0)