Skip to content

DOC: Improve consistency in terminology and fix minor typos in documentation #62091

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 6 commits into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 6 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,9 +19,9 @@
**pandas** is a Python package that provides fast, flexible, and expressive data
structures designed to make working with "relational" or "labeled" data both
easy and intuitive. It aims to be the fundamental high-level building block for
doing practical, **real world** data analysis in Python. Additionally, it has
the broader goal of becoming **the most powerful and flexible open source data
analysis / manipulation tool available in any language**. It is already well on
doing practical, **real-world** data analysis in Python. Additionally, it has
the broader goal of becoming **the most powerful and flexible open-source data
analysis/manipulation tool available in any language**. It is already well on
its way towards this goal.

## Table of Contents
Expand Down Expand Up @@ -64,7 +64,7 @@ Here are just a few of the things that pandas does well:
data sets
- [**Hierarchical**][mi] labeling of axes (possible to have multiple
labels per tick)
- Robust IO tools for loading data from [**flat files**][flat-files]
- Robust I/O tools for loading data from [**flat files**][flat-files]
(CSV and delimited), [**Excel files**][excel], [**databases**][db],
and saving/loading data from the ultrafast [**HDF5 format**][hdfstore]
- [**Time series**][timeseries]-specific functionality: date range
Expand Down Expand Up @@ -138,7 +138,7 @@ or for installing in [development mode](https://pip.pypa.io/en/latest/cli/pip_in


```sh
python -m pip install -ve . --no-build-isolation -Ceditable-verbose=true
python -m pip install -ve . --no-build-isolation --config-settings editable-verbose=true
```

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

## Getting Help

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

## Discussion and Development
Expand Down
4 changes: 2 additions & 2 deletions pandas/_config/config.py
Original file line number Diff line number Diff line change
Expand Up @@ -693,8 +693,8 @@ def _get_registered_option(key: str):

def _translate_key(key: str) -> str:
"""
if key id deprecated and a replacement key defined, will return the
replacement key, otherwise returns `key` as - is
if `key` is deprecated and a replacement key defined, will return the
replacement key, otherwise returns `key` as-is
"""
d = _get_deprecated_option(key)
if d:
Expand Down
2 changes: 1 addition & 1 deletion pandas/_version.py
Original file line number Diff line number Diff line change
Expand Up @@ -581,7 +581,7 @@ def render_git_describe(pieces):
def render_git_describe_long(pieces):
"""TAG-DISTANCE-gHEX[-dirty].

Like 'git describe --tags --dirty --always -long'.
Like 'git describe --tags --dirty --always --long'.
The distance/hash is unconditional.

Exceptions:
Expand Down
4 changes: 2 additions & 2 deletions pandas/core/accessor.py
Original file line number Diff line number Diff line change
Expand Up @@ -88,7 +88,7 @@ def _add_delegate_accessors(
cls
Class to add the methods/properties to.
delegate
Class to get methods/properties and doc-strings.
Class to get methods/properties and docstrings.
accessors : list of str
List of accessors to add.
typ : {'property', 'method'}
Expand Down Expand Up @@ -159,7 +159,7 @@ def delegate_names(
Parameters
----------
delegate : object
The class to get methods/properties & doc-strings.
The class to get methods/properties & docstrings.
accessors : Sequence[str]
List of accessor to add.
typ : {'property', 'method'}
Expand Down
2 changes: 1 addition & 1 deletion pandas/core/base.py
Original file line number Diff line number Diff line change
Expand Up @@ -90,7 +90,7 @@

class PandasObject(DirNamesMixin):
"""
Baseclass for various pandas objects.
Base class for various pandas objects.
"""

# results from calls to methods decorated with cache_readonly get added to _cache
Expand Down
2 changes: 1 addition & 1 deletion pandas/core/indexing.py
Original file line number Diff line number Diff line change
Expand Up @@ -1926,7 +1926,7 @@ def _setitem_with_indexer(self, indexer, value, name: str = "iloc") -> None:
labels = index.insert(len(index), key)

# We are expanding the Series/DataFrame values to match
# the length of thenew index `labels`. GH#40096 ensure
# the length of the new index `labels`. GH#40096 ensure
# this is valid even if the index has duplicates.
taker = np.arange(len(index) + 1, dtype=np.intp)
taker[-1] = -1
Expand Down
2 changes: 1 addition & 1 deletion pandas/io/api.py
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
"""
Data IO api
Data I/O API
"""

from pandas.io.clipboards import read_clipboard
Expand Down
2 changes: 1 addition & 1 deletion pandas/io/common.py
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
"""Common IO api utilities"""
"""Common I/O API utilities"""

from __future__ import annotations

Expand Down
Loading