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

[DOC] Broken reference in StringMethod and CategoricalAccessor #7320

Closed
isVoid opened this issue Feb 4, 2021 · 3 comments · Fixed by #7416
Closed

[DOC] Broken reference in StringMethod and CategoricalAccessor #7320

isVoid opened this issue Feb 4, 2021 · 3 comments · Fixed by #7416
Assignees
@isVoid
Labels
doc Documentation Python Affects Python cuDF API.

Comments

@isVoid
Copy link
Contributor

isVoid commented Feb 4, 2021

Report incorrect documentation

Describe the problems or issues found in the documentation

/raid/wangm/dev/rapids/cudf/python/cudf/cudf/core/column/string.py:docstring of cudf.core.column.string.StringMethods.byte_count:: WARNING: py:class reference target not found: cudf.Series
...
/raid/wangm/dev/rapids/cudf/python/cudf/cudf/core/column/categorical.py:docstring of cudf.core.column.categorical.CategoricalAccessor.set_categories:: WARNING: py:class reference target not found: cudf.Index

Steps taken to verify documentation is incorrect
run docs-cudf-python on branch-0.18

Suggested fix for documentation
Add proper reference to the classes

Full error:

``` /raid/wangm/dev/rapids/cudf/python/cudf/cudf/core/column/string.py:docstring of cudf.core.column.string.StringMethods.byte_count:: WARNING: py:class reference target not found: cudf.Series /raid/wangm/dev/rapids/cudf/python/cudf/cudf/core/column/string.py:docstring of cudf.core.column.string.StringMethods.byte_count:: WARNING: py:class reference target not found: cudf.Index /raid/wangm/dev/rapids/cudf/python/cudf/cudf/core/column/string.py:docstring of cudf.core.column.string.StringMethods.capitalize:: WARNING: py:class reference target not found: cudf.Series /raid/wangm/dev/rapids/cudf/python/cudf/cudf/core/column/string.py:docstring of cudf.core.column.string.StringMethods.capitalize:: WARNING: py:class reference target not found: cudf.Index /raid/wangm/dev/rapids/cudf/python/cudf/cudf/core/column/string.py:docstring of cudf.core.column.string.StringMethods.cat:: WARNING: py:class reference target not found: cudf.Series /raid/wangm/dev/rapids/cudf/python/cudf/cudf/core/column/string.py:docstring of cudf.core.column.string.StringMethods.cat:: WARNING: py:class reference target not found: cudf.Index /raid/wangm/dev/rapids/cudf/python/cudf/cudf/core/column/string.py:docstring of cudf.core.column.string.StringMethods.cat:: WARNING: py:class reference target not found: cudf.core.column.StringColumn /raid/wangm/dev/rapids/cudf/python/cudf/cudf/core/column/string.py:docstring of cudf.core.column.string.StringMethods.center:: WARNING: py:class reference target not found: cudf.Series /raid/wangm/dev/rapids/cudf/python/cudf/cudf/core/column/string.py:docstring of cudf.core.column.string.StringMethods.center:: WARNING: py:class reference target not found: cudf.Index /raid/wangm/dev/rapids/cudf/python/cudf/cudf/core/column/string.py:docstring of cudf.core.column.string.StringMethods.character_ngrams:: WARNING: py:class reference target not found: cudf.Series /raid/wangm/dev/rapids/cudf/python/cudf/cudf/core/column/string.py:docstring of cudf.core.column.string.StringMethods.character_ngrams:: WARNING: py:class reference target not found: cudf.Index /raid/wangm/dev/rapids/cudf/python/cudf/cudf/core/column/string.py:docstring of cudf.core.column.string.StringMethods.character_tokenize:: WARNING: py:class reference target not found: cudf.Series /raid/wangm/dev/rapids/cudf/python/cudf/cudf/core/column/string.py:docstring of cudf.core.column.string.StringMethods.character_tokenize:: WARNING: py:class reference target not found: cudf.Index /raid/wangm/dev/rapids/cudf/python/cudf/cudf/core/column/string.py:docstring of cudf.core.column.string.StringMethods.code_points:: WARNING: py:class reference target not found: cudf.Series /raid/wangm/dev/rapids/cudf/python/cudf/cudf/core/column/string.py:docstring of cudf.core.column.string.StringMethods.code_points:: WARNING: py:class reference target not found: cudf.Index /raid/wangm/dev/rapids/cudf/python/cudf/cudf/core/column/string.py:docstring of cudf.core.column.string.StringMethods.contains:: WARNING: py:class reference target not found: cudf.Series /raid/wangm/dev/rapids/cudf/python/cudf/cudf/core/column/string.py:docstring of cudf.core.column.string.StringMethods.contains:: WARNING: py:class reference target not found: cudf.Index /raid/wangm/dev/rapids/cudf/python/cudf/cudf/core/column/string.py:docstring of cudf.core.column.string.StringMethods.count:: WARNING: py:class reference target not found: cudf.Series /raid/wangm/dev/rapids/cudf/python/cudf/cudf/core/column/string.py:docstring of cudf.core.column.string.StringMethods.count:: WARNING: py:class reference target not found: cudf.Index /raid/wangm/dev/rapids/cudf/python/cudf/cudf/core/column/string.py:docstring of cudf.core.column.string.StringMethods.detokenize:: WARNING: py:class reference target not found: cudf.Series /raid/wangm/dev/rapids/cudf/python/cudf/cudf/core/column/string.py:docstring of cudf.core.column.string.StringMethods.detokenize:: WARNING: py:class reference target not found: cudf.Series /raid/wangm/dev/rapids/cudf/python/cudf/cudf/core/column/string.py:docstring of cudf.core.column.string.StringMethods.detokenize:: WARNING: py:class reference target not found: cudf.Index /raid/wangm/dev/rapids/cudf/python/cudf/cudf/core/column/string.py:docstring of cudf.core.column.string.StringMethods.edit_distance:: WARNING: py:class reference target not found: cudf.Series /raid/wangm/dev/rapids/cudf/python/cudf/cudf/core/column/string.py:docstring of cudf.core.column.string.StringMethods.edit_distance:: WARNING: py:class reference target not found: cudf.Index /raid/wangm/dev/rapids/cudf/python/cudf/cudf/core/column/string.py:docstring of cudf.core.column.string.StringMethods.endswith:: WARNING: py:class reference target not found: cudf.Series /raid/wangm/dev/rapids/cudf/python/cudf/cudf/core/column/string.py:docstring of cudf.core.column.string.StringMethods.endswith:: WARNING: py:class reference target not found: cudf.Index /raid/wangm/dev/rapids/cudf/python/cudf/cudf/core/column/string.py:docstring of cudf.core.column.string.StringMethods.extract:: WARNING: py:class reference target not found: cudf.Series /raid/wangm/dev/rapids/cudf/python/cudf/cudf/core/column/string.py:docstring of cudf.core.column.string.StringMethods.extract:: WARNING: py:class reference target not found: cudf.Index /raid/wangm/dev/rapids/cudf/python/cudf/cudf/core/column/string.py:docstring of cudf.core.column.string.StringMethods.filter_alphanum:: WARNING: py:class reference target not found: cudf.Series /raid/wangm/dev/rapids/cudf/python/cudf/cudf/core/column/string.py:docstring of cudf.core.column.string.StringMethods.filter_alphanum:: WARNING: py:class reference target not found: cudf.Index /raid/wangm/dev/rapids/cudf/python/cudf/cudf/core/column/string.py:docstring of cudf.core.column.string.StringMethods.filter_characters:: WARNING: py:class reference target not found: cudf.Series /raid/wangm/dev/rapids/cudf/python/cudf/cudf/core/column/string.py:docstring of cudf.core.column.string.StringMethods.filter_characters:: WARNING: py:class reference target not found: cudf.Index /raid/wangm/dev/rapids/cudf/python/cudf/cudf/core/column/string.py:docstring of cudf.core.column.string.StringMethods.filter_tokens:: WARNING: py:class reference target not found: cudf.Series /raid/wangm/dev/rapids/cudf/python/cudf/cudf/core/column/string.py:docstring of cudf.core.column.string.StringMethods.filter_tokens:: WARNING: py:class reference target not found: cudf.Index /raid/wangm/dev/rapids/cudf/python/cudf/cudf/core/column/string.py:docstring of cudf.core.column.string.StringMethods.find:: WARNING: py:class reference target not found: cudf.Series /raid/wangm/dev/rapids/cudf/python/cudf/cudf/core/column/string.py:docstring of cudf.core.column.string.StringMethods.find:: WARNING: py:class reference target not found: cudf.Index /raid/wangm/dev/rapids/cudf/python/cudf/cudf/core/column/string.py:docstring of cudf.core.column.string.StringMethods.findall:: WARNING: py:class reference target not found: cudf.Series /raid/wangm/dev/rapids/cudf/python/cudf/cudf/core/column/string.py:docstring of cudf.core.column.string.StringMethods.findall:: WARNING: py:class reference target not found: cudf.Index /raid/wangm/dev/rapids/cudf/python/cudf/cudf/core/column/string.py:docstring of cudf.core.column.string.StringMethods.get:: WARNING: py:class reference target not found: cudf.Series /raid/wangm/dev/rapids/cudf/python/cudf/cudf/core/column/string.py:docstring of cudf.core.column.string.StringMethods.get:: WARNING: py:class reference target not found: cudf.Index /raid/wangm/dev/rapids/cudf/python/cudf/cudf/core/column/string.py:docstring of cudf.core.column.string.StringMethods.htoi:: WARNING: py:class reference target not found: cudf.Series /raid/wangm/dev/rapids/cudf/python/cudf/cudf/core/column/string.py:docstring of cudf.core.column.string.StringMethods.htoi:: WARNING: py:class reference target not found: cudf.Index /raid/wangm/dev/rapids/cudf/python/cudf/cudf/core/column/string.py:docstring of cudf.core.column.string.StringMethods.index:: WARNING: py:class reference target not found: cudf.Series /raid/wangm/dev/rapids/cudf/python/cudf/cudf/core/column/string.py:docstring of cudf.core.column.string.StringMethods.index:: WARNING: py:class reference target not found: cudf.Index /raid/wangm/dev/rapids/cudf/python/cudf/cudf/core/column/string.py:docstring of cudf.core.column.string.StringMethods.insert:: WARNING: py:class reference target not found: cudf.Series /raid/wangm/dev/rapids/cudf/python/cudf/cudf/core/column/string.py:docstring of cudf.core.column.string.StringMethods.insert:: WARNING: py:class reference target not found: cudf.Index /raid/wangm/dev/rapids/cudf/python/cudf/cudf/core/column/string.py:docstring of cudf.core.column.string.StringMethods.ip2int:: WARNING: py:class reference target not found: cudf.Series /raid/wangm/dev/rapids/cudf/python/cudf/cudf/core/column/string.py:docstring of cudf.core.column.string.StringMethods.ip2int:: WARNING: py:class reference target not found: cudf.Index /raid/wangm/dev/rapids/cudf/python/cudf/cudf/core/column/string.py:docstring of cudf.core.column.string.StringMethods.is_consonant:: WARNING: py:class reference target not found: cudf.Series /raid/wangm/dev/rapids/cudf/python/cudf/cudf/core/column/string.py:docstring of cudf.core.column.string.StringMethods.is_consonant:: WARNING: py:class reference target not found: cudf.Index /raid/wangm/dev/rapids/cudf/python/cudf/cudf/core/column/string.py:docstring of cudf.core.column.string.StringMethods.is_vowel:: WARNING: py:class reference target not found: cudf.Series /raid/wangm/dev/rapids/cudf/python/cudf/cudf/core/column/string.py:docstring of cudf.core.column.string.StringMethods.is_vowel:: WARNING: py:class reference target not found: cudf.Index /raid/wangm/dev/rapids/cudf/python/cudf/cudf/core/column/string.py:docstring of cudf.core.column.string.StringMethods.isalnum:: WARNING: py:class reference target not found: cudf.Series /raid/wangm/dev/rapids/cudf/python/cudf/cudf/core/column/string.py:docstring of cudf.core.column.string.StringMethods.isalnum:: WARNING: py:class reference target not found: cudf.Index /raid/wangm/dev/rapids/cudf/python/cudf/cudf/core/column/string.py:docstring of cudf.core.column.string.StringMethods.isalpha:: WARNING: py:class reference target not found: cudf.Series /raid/wangm/dev/rapids/cudf/python/cudf/cudf/core/column/string.py:docstring of cudf.core.column.string.StringMethods.isalpha:: WARNING: py:class reference target not found: cudf.Index /raid/wangm/dev/rapids/cudf/python/cudf/cudf/core/column/string.py:docstring of cudf.core.column.string.StringMethods.isdecimal:: WARNING: py:class reference target not found: cudf.Series /raid/wangm/dev/rapids/cudf/python/cudf/cudf/core/column/string.py:docstring of cudf.core.column.string.StringMethods.isdecimal:: WARNING: py:class reference target not found: cudf.Index /raid/wangm/dev/rapids/cudf/python/cudf/cudf/core/column/string.py:docstring of cudf.core.column.string.StringMethods.isdigit:: WARNING: py:class reference target not found: cudf.Series /raid/wangm/dev/rapids/cudf/python/cudf/cudf/core/column/string.py:docstring of cudf.core.column.string.StringMethods.isdigit:: WARNING: py:class reference target not found: cudf.Index /raid/wangm/dev/rapids/cudf/python/cudf/cudf/core/column/string.py:docstring of cudf.core.column.string.StringMethods.isempty:: WARNING: py:class reference target not found: cudf.Series /raid/wangm/dev/rapids/cudf/python/cudf/cudf/core/column/string.py:docstring of cudf.core.column.string.StringMethods.isempty:: WARNING: py:class reference target not found: cudf.Index /raid/wangm/dev/rapids/cudf/python/cudf/cudf/core/column/string.py:docstring of cudf.core.column.string.StringMethods.isfloat:: WARNING: py:class reference target not found: cudf.Series /raid/wangm/dev/rapids/cudf/python/cudf/cudf/core/column/string.py:docstring of cudf.core.column.string.StringMethods.isfloat:: WARNING: py:class reference target not found: cudf.Index /raid/wangm/dev/rapids/cudf/python/cudf/cudf/core/column/string.py:docstring of cudf.core.column.string.StringMethods.ishex:: WARNING: py:class reference target not found: cudf.Series /raid/wangm/dev/rapids/cudf/python/cudf/cudf/core/column/string.py:docstring of cudf.core.column.string.StringMethods.ishex:: WARNING: py:class reference target not found: cudf.Index /raid/wangm/dev/rapids/cudf/python/cudf/cudf/core/column/string.py:docstring of cudf.core.column.string.StringMethods.isinteger:: WARNING: py:class reference target not found: cudf.Series /raid/wangm/dev/rapids/cudf/python/cudf/cudf/core/column/string.py:docstring of cudf.core.column.string.StringMethods.isinteger:: WARNING: py:class reference target not found: cudf.Index /raid/wangm/dev/rapids/cudf/python/cudf/cudf/core/column/string.py:docstring of cudf.core.column.string.StringMethods.isipv4:: WARNING: py:class reference target not found: cudf.Series /raid/wangm/dev/rapids/cudf/python/cudf/cudf/core/column/string.py:docstring of cudf.core.column.string.StringMethods.isipv4:: WARNING: py:class reference target not found: cudf.Index /raid/wangm/dev/rapids/cudf/python/cudf/cudf/core/column/string.py:docstring of cudf.core.column.string.StringMethods.islower:: WARNING: py:class reference target not found: cudf.Series /raid/wangm/dev/rapids/cudf/python/cudf/cudf/core/column/string.py:docstring of cudf.core.column.string.StringMethods.islower:: WARNING: py:class reference target not found: cudf.Index /raid/wangm/dev/rapids/cudf/python/cudf/cudf/core/column/string.py:docstring of cudf.core.column.string.StringMethods.isnumeric:: WARNING: py:class reference target not found: cudf.Series /raid/wangm/dev/rapids/cudf/python/cudf/cudf/core/column/string.py:docstring of cudf.core.column.string.StringMethods.isnumeric:: WARNING: py:class reference target not found: cudf.Index /raid/wangm/dev/rapids/cudf/python/cudf/cudf/core/column/string.py:docstring of cudf.core.column.string.StringMethods.isspace:: WARNING: py:class reference target not found: cudf.Series /raid/wangm/dev/rapids/cudf/python/cudf/cudf/core/column/string.py:docstring of cudf.core.column.string.StringMethods.isspace:: WARNING: py:class reference target not found: cudf.Index /raid/wangm/dev/rapids/cudf/python/cudf/cudf/core/column/string.py:docstring of cudf.core.column.string.StringMethods.istimestamp:: WARNING: py:class reference target not found: cudf.Series /raid/wangm/dev/rapids/cudf/python/cudf/cudf/core/column/string.py:docstring of cudf.core.column.string.StringMethods.istimestamp:: WARNING: py:class reference target not found: cudf.Index /raid/wangm/dev/rapids/cudf/python/cudf/cudf/core/column/string.py:docstring of cudf.core.column.string.StringMethods.isupper:: WARNING: py:class reference target not found: cudf.Series /raid/wangm/dev/rapids/cudf/python/cudf/cudf/core/column/string.py:docstring of cudf.core.column.string.StringMethods.isupper:: WARNING: py:class reference target not found: cudf.Index /raid/wangm/dev/rapids/cudf/python/cudf/cudf/core/column/string.py:docstring of cudf.core.column.string.StringMethods.join:: WARNING: py:class reference target not found: cudf.Series /raid/wangm/dev/rapids/cudf/python/cudf/cudf/core/column/string.py:docstring of cudf.core.column.string.StringMethods.join:: WARNING: py:class reference target not found: cudf.Index /raid/wangm/dev/rapids/cudf/python/cudf/cudf/core/column/string.py:docstring of cudf.core.column.string.StringMethods.len:: WARNING: py:class reference target not found: cudf.Series /raid/wangm/dev/rapids/cudf/python/cudf/cudf/core/column/string.py:docstring of cudf.core.column.string.StringMethods.len:: WARNING: py:class reference target not found: cudf.Index /raid/wangm/dev/rapids/cudf/python/cudf/cudf/core/column/string.py:docstring of cudf.core.column.string.StringMethods.ljust:: WARNING: py:class reference target not found: cudf.Series /raid/wangm/dev/rapids/cudf/python/cudf/cudf/core/column/string.py:docstring of cudf.core.column.string.StringMethods.ljust:: WARNING: py:class reference target not found: cudf.Index /raid/wangm/dev/rapids/cudf/python/cudf/cudf/core/column/string.py:docstring of cudf.core.column.string.StringMethods.lower:: WARNING: py:class reference target not found: cudf.Series /raid/wangm/dev/rapids/cudf/python/cudf/cudf/core/column/string.py:docstring of cudf.core.column.string.StringMethods.lower:: WARNING: py:class reference target not found: cudf.Index /raid/wangm/dev/rapids/cudf/python/cudf/cudf/core/column/string.py:docstring of cudf.core.column.string.StringMethods.lstrip:: WARNING: py:class reference target not found: cudf.Series /raid/wangm/dev/rapids/cudf/python/cudf/cudf/core/column/string.py:docstring of cudf.core.column.string.StringMethods.lstrip:: WARNING: py:class reference target not found: cudf.Index /raid/wangm/dev/rapids/cudf/python/cudf/cudf/core/column/string.py:docstring of cudf.core.column.string.StringMethods.match:: WARNING: py:class reference target not found: cudf.Series /raid/wangm/dev/rapids/cudf/python/cudf/cudf/core/column/string.py:docstring of cudf.core.column.string.StringMethods.match:: WARNING: py:class reference target not found: cudf.Index /raid/wangm/dev/rapids/cudf/python/cudf/cudf/core/column/string.py:docstring of cudf.core.column.string.StringMethods.ngrams:: WARNING: py:class reference target not found: cudf.Series /raid/wangm/dev/rapids/cudf/python/cudf/cudf/core/column/string.py:docstring of cudf.core.column.string.StringMethods.ngrams:: WARNING: py:class reference target not found: cudf.Index /raid/wangm/dev/rapids/cudf/python/cudf/cudf/core/column/string.py:docstring of cudf.core.column.string.StringMethods.ngrams_tokenize:: WARNING: py:class reference target not found: cudf.Series /raid/wangm/dev/rapids/cudf/python/cudf/cudf/core/column/string.py:docstring of cudf.core.column.string.StringMethods.ngrams_tokenize:: WARNING: py:class reference target not found: cudf.Index /raid/wangm/dev/rapids/cudf/python/cudf/cudf/core/column/string.py:docstring of cudf.core.column.string.StringMethods.normalize_characters:: WARNING: py:class reference target not found: cudf.Series /raid/wangm/dev/rapids/cudf/python/cudf/cudf/core/column/string.py:docstring of cudf.core.column.string.StringMethods.normalize_characters:: WARNING: py:class reference target not found: cudf.Index /raid/wangm/dev/rapids/cudf/python/cudf/cudf/core/column/string.py:docstring of cudf.core.column.string.StringMethods.normalize_spaces:: WARNING: py:class reference target not found: cudf.Series /raid/wangm/dev/rapids/cudf/python/cudf/cudf/core/column/string.py:docstring of cudf.core.column.string.StringMethods.normalize_spaces:: WARNING: py:class reference target not found: cudf.Index /raid/wangm/dev/rapids/cudf/python/cudf/cudf/core/column/string.py:docstring of cudf.core.column.string.StringMethods.pad:: WARNING: py:class reference target not found: cudf.Series /raid/wangm/dev/rapids/cudf/python/cudf/cudf/core/column/string.py:docstring of cudf.core.column.string.StringMethods.pad:: WARNING: py:class reference target not found: cudf.Index /raid/wangm/dev/rapids/cudf/python/cudf/cudf/core/column/string.py:docstring of cudf.core.column.string.StringMethods.partition:: WARNING: py:class reference target not found: cudf.Series /raid/wangm/dev/rapids/cudf/python/cudf/cudf/core/column/string.py:docstring of cudf.core.column.string.StringMethods.partition:: WARNING: py:class reference target not found: cudf.Index /raid/wangm/dev/rapids/cudf/python/cudf/cudf/core/column/string.py:docstring of cudf.core.column.string.StringMethods.porter_stemmer_measure:: WARNING: py:class reference target not found: cudf.Series /raid/wangm/dev/rapids/cudf/python/cudf/cudf/core/column/string.py:docstring of cudf.core.column.string.StringMethods.porter_stemmer_measure:: WARNING: py:class reference target not found: cudf.Index /raid/wangm/dev/rapids/cudf/python/cudf/cudf/core/column/string.py:docstring of cudf.core.column.string.StringMethods.replace:: WARNING: py:class reference target not found: cudf.Series /raid/wangm/dev/rapids/cudf/python/cudf/cudf/core/column/string.py:docstring of cudf.core.column.string.StringMethods.replace:: WARNING: py:class reference target not found: cudf.Index /raid/wangm/dev/rapids/cudf/python/cudf/cudf/core/column/string.py:docstring of cudf.core.column.string.StringMethods.replace_tokens:: WARNING: py:class reference target not found: cudf.Series /raid/wangm/dev/rapids/cudf/python/cudf/cudf/core/column/string.py:docstring of cudf.core.column.string.StringMethods.replace_tokens:: WARNING: py:class reference target not found: cudf.Index /raid/wangm/dev/rapids/cudf/python/cudf/cudf/core/column/string.py:docstring of cudf.core.column.string.StringMethods.replace_with_backrefs:: WARNING: py:class reference target not found: cudf.Series /raid/wangm/dev/rapids/cudf/python/cudf/cudf/core/column/string.py:docstring of cudf.core.column.string.StringMethods.replace_with_backrefs:: WARNING: py:class reference target not found: cudf.Index /raid/wangm/dev/rapids/cudf/python/cudf/cudf/core/column/string.py:docstring of cudf.core.column.string.StringMethods.rfind:: WARNING: py:class reference target not found: cudf.Series /raid/wangm/dev/rapids/cudf/python/cudf/cudf/core/column/string.py:docstring of cudf.core.column.string.StringMethods.rfind:: WARNING: py:class reference target not found: cudf.Index /raid/wangm/dev/rapids/cudf/python/cudf/cudf/core/column/string.py:docstring of cudf.core.column.string.StringMethods.rindex:: WARNING: py:class reference target not found: cudf.Series /raid/wangm/dev/rapids/cudf/python/cudf/cudf/core/column/string.py:docstring of cudf.core.column.string.StringMethods.rindex:: WARNING: py:class reference target not found: cudf.Index /raid/wangm/dev/rapids/cudf/python/cudf/cudf/core/column/string.py:docstring of cudf.core.column.string.StringMethods.rjust:: WARNING: py:class reference target not found: cudf.Series /raid/wangm/dev/rapids/cudf/python/cudf/cudf/core/column/string.py:docstring of cudf.core.column.string.StringMethods.rjust:: WARNING: py:class reference target not found: cudf.Index /raid/wangm/dev/rapids/cudf/python/cudf/cudf/core/column/string.py:docstring of cudf.core.column.string.StringMethods.rpartition:: WARNING: py:class reference target not found: cudf.Series /raid/wangm/dev/rapids/cudf/python/cudf/cudf/core/column/string.py:docstring of cudf.core.column.string.StringMethods.rpartition:: WARNING: py:class reference target not found: cudf.Index /raid/wangm/dev/rapids/cudf/python/cudf/cudf/core/column/string.py:docstring of cudf.core.column.string.StringMethods.rsplit:: WARNING: py:class reference target not found: cudf.Series /raid/wangm/dev/rapids/cudf/python/cudf/cudf/core/column/string.py:docstring of cudf.core.column.string.StringMethods.rsplit:: WARNING: py:class reference target not found: cudf.Index /raid/wangm/dev/rapids/cudf/python/cudf/cudf/core/column/string.py:docstring of cudf.core.column.string.StringMethods.rstrip:: WARNING: py:class reference target not found: cudf.Series /raid/wangm/dev/rapids/cudf/python/cudf/cudf/core/column/string.py:docstring of cudf.core.column.string.StringMethods.rstrip:: WARNING: py:class reference target not found: cudf.Index /raid/wangm/dev/rapids/cudf/python/cudf/cudf/core/column/string.py:docstring of cudf.core.column.string.StringMethods.slice:: WARNING: py:class reference target not found: cudf.Series /raid/wangm/dev/rapids/cudf/python/cudf/cudf/core/column/string.py:docstring of cudf.core.column.string.StringMethods.slice:: WARNING: py:class reference target not found: cudf.Index /raid/wangm/dev/rapids/cudf/python/cudf/cudf/core/column/string.py:docstring of cudf.core.column.string.StringMethods.slice_from:: WARNING: py:class reference target not found: cudf.Series /raid/wangm/dev/rapids/cudf/python/cudf/cudf/core/column/string.py:docstring of cudf.core.column.string.StringMethods.slice_from:: WARNING: py:class reference target not found: cudf.Series /raid/wangm/dev/rapids/cudf/python/cudf/cudf/core/column/string.py:docstring of cudf.core.column.string.StringMethods.slice_from:: WARNING: py:class reference target not found: cudf.Series /raid/wangm/dev/rapids/cudf/python/cudf/cudf/core/column/string.py:docstring of cudf.core.column.string.StringMethods.slice_from:: WARNING: py:class reference target not found: cudf.Index /raid/wangm/dev/rapids/cudf/python/cudf/cudf/core/column/string.py:docstring of cudf.core.column.string.StringMethods.slice_replace:: WARNING: py:class reference target not found: cudf.Series /raid/wangm/dev/rapids/cudf/python/cudf/cudf/core/column/string.py:docstring of cudf.core.column.string.StringMethods.slice_replace:: WARNING: py:class reference target not found: cudf.Index /raid/wangm/dev/rapids/cudf/python/cudf/cudf/core/column/string.py:docstring of cudf.core.column.string.StringMethods.split:: WARNING: py:class reference target not found: cudf.Series /raid/wangm/dev/rapids/cudf/python/cudf/cudf/core/column/string.py:docstring of cudf.core.column.string.StringMethods.split:: WARNING: py:class reference target not found: cudf.Index /raid/wangm/dev/rapids/cudf/python/cudf/cudf/core/column/string.py:docstring of cudf.core.column.string.StringMethods.startswith:: WARNING: py:class reference target not found: cudf.Series /raid/wangm/dev/rapids/cudf/python/cudf/cudf/core/column/string.py:docstring of cudf.core.column.string.StringMethods.startswith:: WARNING: py:class reference target not found: cudf.Index /raid/wangm/dev/rapids/cudf/python/cudf/cudf/core/column/string.py:docstring of cudf.core.column.string.StringMethods.strip:: WARNING: py:class reference target not found: cudf.Series /raid/wangm/dev/rapids/cudf/python/cudf/cudf/core/column/string.py:docstring of cudf.core.column.string.StringMethods.strip:: WARNING: py:class reference target not found: cudf.Index /raid/wangm/dev/rapids/cudf/python/cudf/cudf/core/column/string.py:docstring of cudf.core.column.string.StringMethods.subword_tokenize:: WARNING: py:class reference target not found: cupy.core.core.ndarray /raid/wangm/dev/rapids/cudf/python/cudf/cudf/core/column/string.py:docstring of cudf.core.column.string.StringMethods.subword_tokenize:: WARNING: py:class reference target not found: cupy.core.core.ndarray /raid/wangm/dev/rapids/cudf/python/cudf/cudf/core/column/string.py:docstring of cudf.core.column.string.StringMethods.subword_tokenize:: WARNING: py:class reference target not found: cupy.core.core.ndarray /raid/wangm/dev/rapids/cudf/python/cudf/cudf/core/column/string.py:docstring of cudf.core.column.string.StringMethods.swapcase:: WARNING: py:class reference target not found: cudf.Series /raid/wangm/dev/rapids/cudf/python/cudf/cudf/core/column/string.py:docstring of cudf.core.column.string.StringMethods.swapcase:: WARNING: py:class reference target not found: cudf.Index /raid/wangm/dev/rapids/cudf/python/cudf/cudf/core/column/string.py:docstring of cudf.core.column.string.StringMethods.title:: WARNING: py:class reference target not found: cudf.Series /raid/wangm/dev/rapids/cudf/python/cudf/cudf/core/column/string.py:docstring of cudf.core.column.string.StringMethods.title:: WARNING: py:class reference target not found: cudf.Index /raid/wangm/dev/rapids/cudf/python/cudf/cudf/core/column/string.py:docstring of cudf.core.column.string.StringMethods.token_count:: WARNING: py:class reference target not found: cudf.Series /raid/wangm/dev/rapids/cudf/python/cudf/cudf/core/column/string.py:docstring of cudf.core.column.string.StringMethods.token_count:: WARNING: py:class reference target not found: cudf.Index /raid/wangm/dev/rapids/cudf/python/cudf/cudf/core/column/string.py:docstring of cudf.core.column.string.StringMethods.tokenize:: WARNING: py:class reference target not found: cudf.Series /raid/wangm/dev/rapids/cudf/python/cudf/cudf/core/column/string.py:docstring of cudf.core.column.string.StringMethods.tokenize:: WARNING: py:class reference target not found: cudf.Index /raid/wangm/dev/rapids/cudf/python/cudf/cudf/core/column/string.py:docstring of cudf.core.column.string.StringMethods.translate:: WARNING: py:class reference target not found: cudf.Series /raid/wangm/dev/rapids/cudf/python/cudf/cudf/core/column/string.py:docstring of cudf.core.column.string.StringMethods.translate:: WARNING: py:class reference target not found: cudf.Index /raid/wangm/dev/rapids/cudf/python/cudf/cudf/core/column/string.py:docstring of cudf.core.column.string.StringMethods.upper:: WARNING: py:class reference target not found: cudf.Series /raid/wangm/dev/rapids/cudf/python/cudf/cudf/core/column/string.py:docstring of cudf.core.column.string.StringMethods.upper:: WARNING: py:class reference target not found: cudf.Index /raid/wangm/dev/rapids/cudf/python/cudf/cudf/core/column/string.py:docstring of cudf.core.column.string.StringMethods.url_decode:: WARNING: py:class reference target not found: cudf.Series /raid/wangm/dev/rapids/cudf/python/cudf/cudf/core/column/string.py:docstring of cudf.core.column.string.StringMethods.url_decode:: WARNING: py:class reference target not found: cudf.Index /raid/wangm/dev/rapids/cudf/python/cudf/cudf/core/column/string.py:docstring of cudf.core.column.string.StringMethods.url_encode:: WARNING: py:class reference target not found: cudf.Series /raid/wangm/dev/rapids/cudf/python/cudf/cudf/core/column/string.py:docstring of cudf.core.column.string.StringMethods.url_encode:: WARNING: py:class reference target not found: cudf.Index /raid/wangm/dev/rapids/cudf/python/cudf/cudf/core/column/string.py:docstring of cudf.core.column.string.StringMethods.wrap:: WARNING: py:class reference target not found: cudf.Series /raid/wangm/dev/rapids/cudf/python/cudf/cudf/core/column/string.py:docstring of cudf.core.column.string.StringMethods.wrap:: WARNING: py:class reference target not found: cudf.Index /raid/wangm/dev/rapids/cudf/python/cudf/cudf/core/column/string.py:docstring of cudf.core.column.string.StringMethods.zfill:: WARNING: py:class reference target not found: cudf.Series /raid/wangm/dev/rapids/cudf/python/cudf/cudf/core/column/string.py:docstring of cudf.core.column.string.StringMethods.zfill:: WARNING: py:class reference target not found: cudf.Index /raid/wangm/dev/rapids/cudf/python/cudf/cudf/core/column/categorical.py:docstring of cudf.core.column.categorical.CategoricalAccessor:: WARNING: py:class reference target not found: cudf.Series /raid/wangm/dev/rapids/cudf/python/cudf/cudf/core/column/categorical.py:docstring of cudf.core.column.categorical.CategoricalAccessor:: WARNING: py:class reference target not found: cudf.Index /raid/wangm/dev/rapids/cudf/python/cudf/cudf/core/column/categorical.py:docstring of cudf.core.column.categorical.CategoricalAccessor.add_categories:: WARNING: py:class reference target not found: cudf.Series /raid/wangm/dev/rapids/cudf/python/cudf/cudf/core/column/categorical.py:docstring of cudf.core.column.categorical.CategoricalAccessor.add_categories:: WARNING: py:class reference target not found: cudf.Index /raid/wangm/dev/rapids/cudf/python/cudf/cudf/core/column/categorical.py:docstring of cudf.core.column.categorical.CategoricalAccessor.as_ordered:: WARNING: py:class reference target not found: cudf.Series /raid/wangm/dev/rapids/cudf/python/cudf/cudf/core/column/categorical.py:docstring of cudf.core.column.categorical.CategoricalAccessor.as_ordered:: WARNING: py:class reference target not found: cudf.Index /raid/wangm/dev/rapids/cudf/python/cudf/cudf/core/column/categorical.py:docstring of cudf.core.column.categorical.CategoricalAccessor.as_unordered:: WARNING: py:class reference target not found: cudf.Series /raid/wangm/dev/rapids/cudf/python/cudf/cudf/core/column/categorical.py:docstring of cudf.core.column.categorical.CategoricalAccessor.as_unordered:: WARNING: py:class reference target not found: cudf.Index /raid/wangm/dev/rapids/cudf/python/cudf/cudf/core/column/categorical.py:docstring of cudf.core.column.categorical.CategoricalAccessor.remove_categories:: WARNING: py:class reference target not found: cudf.Series /raid/wangm/dev/rapids/cudf/python/cudf/cudf/core/column/categorical.py:docstring of cudf.core.column.categorical.CategoricalAccessor.remove_categories:: WARNING: py:class reference target not found: cudf.Index /raid/wangm/dev/rapids/cudf/python/cudf/cudf/core/column/categorical.py:docstring of cudf.core.column.categorical.CategoricalAccessor.reorder_categories:: WARNING: py:class reference target not found: cudf.Series /raid/wangm/dev/rapids/cudf/python/cudf/cudf/core/column/categorical.py:docstring of cudf.core.column.categorical.CategoricalAccessor.reorder_categories:: WARNING: py:class reference target not found: cudf.Index /raid/wangm/dev/rapids/cudf/python/cudf/cudf/core/column/categorical.py:docstring of cudf.core.column.categorical.CategoricalAccessor.set_categories:: WARNING: py:class reference target not found: cudf.Series /raid/wangm/dev/rapids/cudf/python/cudf/cudf/core/column/categorical.py:docstring of cudf.core.column.categorical.CategoricalAccessor.set_categories:: WARNING: py:class reference target not found: cudf.Index ```
@isVoid isVoid added doc Documentation Needs Triage Need team to review and classify labels Feb 4, 2021
@isVoid isVoid self-assigned this Feb 4, 2021
@isVoid
Copy link
Contributor Author

isVoid commented Feb 5, 2021 •
edited
Loading

The root issue is that when using forward reference in typing annotation, sphinx wasn't able to derive from the package shorthand. (Such as cudf.Series actually means cudf.core.series.Series)

A quick and dirty fix is just to use cudf.core.series.Series everywhere when cudf.Series is used. A more decent way to do it is outlined here:
https://stackoverflow.com/a/62301461

In conf.py, we setup a mapping {'shorthand': ('real-ref', 'displayed-text')}, traverse the doctree and replace all shorthand usages with real-ref and set display text accordingly.

Open to suggestions!

cc @rapidsai/cudf-python-codeowners

@shwina
Copy link
Contributor

shwina commented Feb 5, 2021

As an aside, these are a rare case of public APIs with type annotations (because we make heavy use of them internally). I wonder if one solution is simply to separate the implementation and public API into a typed part and untyped shim layer respectively.

@kkraus14 kkraus14 added Python Affects Python cuDF API. and removed Needs Triage Need team to review and classify labels Feb 10, 2021
@kkraus14
Copy link
Collaborator

We shouldn't have to make an additional shim layer in order to use type annotations. We should do whatever we need to from the Sphinx side in order to avoid having to add an additional layer of indirection in cuDF.

@isVoid isVoid mentioned this issue Feb 20, 2021
Merged
@rapids-bot rapids-bot bot closed this as completed in #7416 Mar 8, 2021
rapids-bot bot pushed a commit that referenced this issue Mar 8, 2021
@isVoid
Resolving unlinked type shorthands in cudf doc (#7416)
ddc0990 
Closes #7320 

This PR adds an additional preprocessing step in documentation generation. It traverses through the doctree generated by Sphinx and replaces unresolved type short hands with proper target reference, while keeping the shortened name for display text.

An additional preprocessing step is added to ignore internal types to APIs facing both internally and externally, such as `cudf.core.column.string.StringColumn`

`cupy` API reference is added to intersphinx.

Minor changes:
- Fixes a small doc bug in `frame.copy`

Authors:
  - Michael Wang (@isVoid)

Approvers:
  - Ashwin Srinath (@shwina)

URL: #7416
hyperbolic2346 pushed a commit to hyperbolic2346/cudf that referenced this issue Mar 25, 2021
@isVoid @hyperbolic2346
Resolving unlinked type shorthands in cudf doc (rapidsai#7416)
6b5b477 
Closes rapidsai#7320 

This PR adds an additional preprocessing step in documentation generation. It traverses through the doctree generated by Sphinx and replaces unresolved type short hands with proper target reference, while keeping the shortened name for display text.

An additional preprocessing step is added to ignore internal types to APIs facing both internally and externally, such as `cudf.core.column.string.StringColumn`

`cupy` API reference is added to intersphinx.

Minor changes:
- Fixes a small doc bug in `frame.copy`

Authors:
  - Michael Wang (@isVoid)

Approvers:
  - Ashwin Srinath (@shwina)

URL: rapidsai#7416
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@isVoid isVoid

Labels
doc Documentation Python Affects Python cuDF API.
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

Resolving unlinked type shorthands in cudf doc isVoid/cudf
3 participants
@shwina @kkraus14 @isVoid