Skip to content
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

Fix docstring section headings. #10639

Merged
merged 1 commit into from
Apr 12, 2022
Merged
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
4 changes: 2 additions & 2 deletions python/cudf/cudf/core/algorithms.py
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Copyright (c) 2020, NVIDIA CORPORATION.
# Copyright (c) 2020-2022, NVIDIA CORPORATION.
from warnings import warn

import cupy as cp
Expand All @@ -21,7 +21,7 @@ def factorize(values, sort=False, na_sentinel=-1, size_hint=None):
Value to indicate missing category.

Returns
--------
-------
(labels, cats) : (cupy.ndarray, cupy.ndarray or Index)
- *labels* contains the encoded values
- *cats* contains the categories in order that the N-th
Expand Down
2 changes: 1 addition & 1 deletion python/cudf/cudf/core/dataframe.py
Original file line number Diff line number Diff line change
Expand Up @@ -1980,7 +1980,7 @@ def update(
None : method directly changes calling object

Raises
-------
------
ValueError
- When ``errors`` = 'raise' and there's overlapping non-NA data.
- When ``errors`` is not either 'ignore' or 'raise'
Expand Down
2 changes: 1 addition & 1 deletion python/cudf/cudf/core/groupby/groupby.py
Original file line number Diff line number Diff line change
Expand Up @@ -907,7 +907,7 @@ def corr(self, method="pearson", min_periods=1):
to have a valid result.

Returns
----------
-------
DataFrame
Correlation matrix.

Expand Down
4 changes: 2 additions & 2 deletions python/cudf/cudf/core/multiindex.py
Original file line number Diff line number Diff line change
Expand Up @@ -206,7 +206,7 @@ def rename(self, names, inplace=False):
``MultiIndex`` instance

Returns
--------
-------
None or MultiIndex

Examples
Expand Down Expand Up @@ -591,7 +591,7 @@ def isin(self, values, level=None):
CuPy array of boolean values.

Notes
-------
-----
When `level` is None, `values` can only be MultiIndex, or a
set/list-like tuples.
When `level` is provided, `values` can be Index or MultiIndex,
Expand Down
2 changes: 1 addition & 1 deletion python/cudf/cudf/core/series.py
Original file line number Diff line number Diff line change
Expand Up @@ -2485,7 +2485,7 @@ def isin(self, values):
Series of booleans indicating if each element is in values.

Raises
-------
------
TypeError
If values is a string

Expand Down
2 changes: 1 addition & 1 deletion python/cudf/cudf/core/single_column_frame.py
Original file line number Diff line number Diff line change
Expand Up @@ -273,7 +273,7 @@ def factorize(self, na_sentinel=-1):
Value to indicate missing category.

Returns
--------
-------
(labels, cats) : (cupy.ndarray, cupy.ndarray or Index)
- *labels* contains the encoded values
- *cats* contains the categories in order that the N-th
Expand Down
2 changes: 1 addition & 1 deletion python/cudf/cudf/utils/cudautils.py
Original file line number Diff line number Diff line change
Expand Up @@ -249,7 +249,7 @@ def compile_udf(udf, type_signature):
numpy types with `numba.numpy_support.from_dtype(...)`.

Returns
--------
-------
ptx_code:
The compiled CUDA PTX

Expand Down
2 changes: 1 addition & 1 deletion python/cudf/cudf/utils/utils.py
Original file line number Diff line number Diff line change
Expand Up @@ -387,7 +387,7 @@ def search_range(start, stop, x, step=1, side="left"):
See description for usage.

Returns
--------
-------
int
Insertion position of n.

Expand Down