Use cudf.read_json as documented API name. (#10640)

Changes documented API name from `cudf.io.json.read_json` to `cudf.read_json`. This aligns with Pandas' documentation and eliminates an awkward switch of the `.. currentmodule` in Sphinx. See thread: #10638 (comment) Authors: - Bradley Dice (https://github.com/bdice) Approvers: - https://github.com/brandon-b-miller URL: #10640
rapidsai · Apr 12, 2022 · d6c15e4 · d6c15e4
1 parent 2348277
commit d6c15e4
Show file tree

Hide file tree

Showing 2 changed files with 3 additions and 7 deletions.
diff --git a/docs/cudf/source/api_docs/io.rst b/docs/cudf/source/api_docs/io.rst
@@ -20,17 +20,13 @@ Text
 
    read_text
 
-.. currentmodule:: cudf.io.json
-
 JSON
 ~~~~
 .. autosummary::
    :toctree: api/
 
    read_json
-   to_json
-
-.. currentmodule:: cudf
+   DataFrame.to_json
 
 Parquet
 ~~~~~~~

diff --git a/python/cudf/cudf/utils/ioutils.py b/python/cudf/cudf/utils/ioutils.py
@@ -561,7 +561,7 @@
 
 See Also
 --------
-.cudf.io.json.to_json
+cudf.DataFrame.to_json
 """
 doc_read_json = docfmt_partial(docstring=_docstring_read_json)
 
@@ -628,7 +628,7 @@
 
 See Also
 --------
-.cudf.io.json.read_json
+cudf.read_json
 """
 doc_to_json = docfmt_partial(docstring=_docstring_to_json)