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.

Sign up for GitHub

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

Jump to bottom

[REVIEW] Fix see also links for IO APIs #9895

Merged
merged 1 commit into from
Dec 17, 2021
Merged

[REVIEW] Fix see also links for IO APIs #9895

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
1 change: 1 addition & 0 deletions docs/cudf/source/api_docs/io.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -33,6 +33,7 @@ Parquet

read_parquet
DataFrame.to_parquet
cudf.io.parquet.read_parquet_metadata

ORC
~~~
Expand Down
24 changes: 12 additions & 12 deletions python/cudf/cudf/utils/ioutils.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -107,7 +107,7 @@

See Also
--------
cudf.io.parquet.read_parquet
cudf.read_parquet
"""
doc_read_parquet_metadata = docfmt_partial(
docstring=_docstring_read_parquet_metadata
Expand Down Expand Up @@ -186,7 +186,7 @@
See Also
--------
cudf.io.parquet.read_parquet_metadata
cudf.io.parquet.to_parquet
cudf.DataFrame.to_parquet
cudf.read_orc
""".format(
remote_data_sources=_docstring_remote_sources
Expand Down Expand Up @@ -234,7 +234,7 @@

See Also
--------
cudf.io.parquet.read_parquet
cudf.read_parquet
cudf.read_orc
"""
doc_to_parquet = docfmt_partial(docstring=_docstring_to_parquet)
Expand All @@ -253,7 +253,7 @@

See Also
--------
cudf.io.parquet.to_parquet
cudf.DataFrame.to_parquet
"""
doc_merge_parquet_filemetadata = docfmt_partial(
docstring=_docstring_merge_parquet_filemetadata
Expand Down Expand Up @@ -392,8 +392,8 @@

See Also
--------
cudf.io.parquet.read_parquet
cudf.io.parquet.to_parquet
cudf.read_parquet
cudf.DataFrame.to_parquet
""".format(
remote_data_sources=_docstring_remote_sources
)
Expand Down Expand Up @@ -660,7 +660,7 @@

See Also
--------
cudf.io.hdf.to_hdf : Write a HDF file from a DataFrame.
cudf.DataFrame.to_hdf : Write a HDF file from a DataFrame.
"""
doc_read_hdf = docfmt_partial(docstring=_docstring_read_hdf)

Expand Down Expand Up @@ -731,8 +731,8 @@
See Also
--------
cudf.read_hdf : Read from HDF file.
cudf.io.parquet.to_parquet : Write a DataFrame to the binary parquet format.
cudf.io.feather.to_feather : Write out feather-format for DataFrames.
cudf.DataFrame.to_parquet : Write a DataFrame to the binary parquet format.
cudf.DataFrame.to_feather : Write out feather-format for DataFrames.
"""
doc_to_hdf = docfmt_partial(docstring=_docstring_to_hdf)

Expand Down Expand Up @@ -762,7 +762,7 @@

See Also
--------
cudf.io.feather.to_feather
cudf.DataFrame.to_feather
"""
doc_read_feather = docfmt_partial(docstring=_docstring_read_feather)

Expand All @@ -776,7 +776,7 @@

See Also
--------
cudf.io.feather.read_feather
cudf.read_feather
"""
doc_to_feather = docfmt_partial(docstring=_docstring_to_feather)

Expand Down Expand Up @@ -945,7 +945,7 @@

See Also
--------
cudf.io.csv.to_csv
cudf.DataFrame.to_csv
""".format(
remote_data_sources=_docstring_remote_sources
)
Expand Down