Skip to content

Commit d5c6794

Browse files
WorkWork
authored andcommitted
DOC: Improve consistency in terminology and fix minor typos in documentation and comments
1 parent 3550556 commit d5c6794

File tree

8 files changed

+14
-14
lines changed

8 files changed

+14
-14
lines changed

README.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@
1919
**pandas** is a Python package that provides fast, flexible, and expressive data
2020
structures designed to make working with "relational" or "labeled" data both
2121
easy and intuitive. It aims to be the fundamental high-level building block for
22-
doing practical, **real world** data analysis in Python. Additionally, it has
22+
doing practical, **real-world** data analysis in Python. Additionally, it has
2323
the broader goal of becoming **the most powerful and flexible open source data
2424
analysis / manipulation tool available in any language**. It is already well on
2525
its way towards this goal.
@@ -64,7 +64,7 @@ Here are just a few of the things that pandas does well:
6464
data sets
6565
- [**Hierarchical**][mi] labeling of axes (possible to have multiple
6666
labels per tick)
67-
- Robust IO tools for loading data from [**flat files**][flat-files]
67+
- Robust I/O tools for loading data from [**flat files**][flat-files]
6868
(CSV and delimited), [**Excel files**][excel], [**databases**][db],
6969
and saving/loading data from the ultrafast [**HDF5 format**][hdfstore]
7070
- [**Time series**][timeseries]-specific functionality: date range
@@ -115,7 +115,7 @@ details, see the commit logs at https://github.com/pandas-dev/pandas.
115115
## Dependencies
116116
- [NumPy - Adds support for large, multi-dimensional arrays, matrices and high-level mathematical functions to operate on these arrays](https://www.numpy.org)
117117
- [python-dateutil - Provides powerful extensions to the standard datetime module](https://dateutil.readthedocs.io/en/stable/index.html)
118-
- [pytz - Brings the Olson tz database into Python which allows accurate and cross platform timezone calculations](https://github.com/stub42/pytz)
118+
- [pytz - Brings the Olson tz database into Python which allows accurate and cross-platform timezone calculations](https://github.com/stub42/pytz)
119119

120120
See the [full installation instructions](https://pandas.pydata.org/pandas-docs/stable/install.html#dependencies) for minimum supported versions of required, recommended and optional dependencies.
121121

@@ -138,7 +138,7 @@ or for installing in [development mode](https://pip.pypa.io/en/latest/cli/pip_in
138138

139139

140140
```sh
141-
python -m pip install -ve . --no-build-isolation -Ceditable-verbose=true
141+
python -m pip install -ve . --no-build-isolation --config-settings editable-verbose=true
142142
```
143143

144144
See the full instructions for [installing from source](https://pandas.pydata.org/docs/dev/development/contributing_environment.html).
@@ -155,7 +155,7 @@ has been under active development since then.
155155

156156
## Getting Help
157157

158-
For usage questions, the best place to go to is [StackOverflow](https://stackoverflow.com/questions/tagged/pandas).
158+
For usage questions, the best place to go to is [Stack Overflow](https://stackoverflow.com/questions/tagged/pandas).
159159
Further, general questions and discussions can also take place on the [pydata mailing list](https://groups.google.com/forum/?fromgroups#!forum/pydata).
160160

161161
## Discussion and Development

pandas/_config/config.py

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -693,8 +693,8 @@ def _get_registered_option(key: str):
693693

694694
def _translate_key(key: str) -> str:
695695
"""
696-
if key id deprecated and a replacement key defined, will return the
697-
replacement key, otherwise returns `key` as - is
696+
if `key` is deprecated and a replacement key defined, will return the
697+
replacement key, otherwise returns `key` as-is
698698
"""
699699
d = _get_deprecated_option(key)
700700
if d:

pandas/_version.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -581,7 +581,7 @@ def render_git_describe(pieces):
581581
def render_git_describe_long(pieces):
582582
"""TAG-DISTANCE-gHEX[-dirty].
583583
584-
Like 'git describe --tags --dirty --always -long'.
584+
Like 'git describe --tags --dirty --always --long'.
585585
The distance/hash is unconditional.
586586
587587
Exceptions:

pandas/core/accessor.py

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -88,7 +88,7 @@ def _add_delegate_accessors(
8888
cls
8989
Class to add the methods/properties to.
9090
delegate
91-
Class to get methods/properties and doc-strings.
91+
Class to get methods/properties and docstrings.
9292
accessors : list of str
9393
List of accessors to add.
9494
typ : {'property', 'method'}
@@ -159,7 +159,7 @@ def delegate_names(
159159
Parameters
160160
----------
161161
delegate : object
162-
The class to get methods/properties & doc-strings.
162+
The class to get methods/properties & docstrings.
163163
accessors : Sequence[str]
164164
List of accessor to add.
165165
typ : {'property', 'method'}

pandas/core/base.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -90,7 +90,7 @@
9090

9191
class PandasObject(DirNamesMixin):
9292
"""
93-
Baseclass for various pandas objects.
93+
Base class for various pandas objects.
9494
"""
9595

9696
# results from calls to methods decorated with cache_readonly get added to _cache

pandas/core/indexing.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1902,7 +1902,7 @@ def _setitem_with_indexer(self, indexer, value, name: str = "iloc") -> None:
19021902
labels = index.insert(len(index), key)
19031903

19041904
# We are expanding the Series/DataFrame values to match
1905-
# the length of thenew index `labels`. GH#40096 ensure
1905+
# the length of the new index `labels`. GH#40096 ensure
19061906
# this is valid even if the index has duplicates.
19071907
taker = np.arange(len(index) + 1, dtype=np.intp)
19081908
taker[-1] = -1

pandas/io/api.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
"""
2-
Data IO api
2+
Data I/O API
33
"""
44

55
from pandas.io.clipboards import read_clipboard

pandas/io/common.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
"""Common IO api utilities"""
1+
"""Common I/O API utilities"""
22

33
from __future__ import annotations
44

0 commit comments

Comments
 (0)