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

[DOC] Some APIs are missing doc examples #5290

Closed
galipremsagar opened this issue May 26, 2020 · 4 comments · Fixed by #7546
Closed

[DOC] Some APIs are missing doc examples #5290

galipremsagar opened this issue May 26, 2020 · 4 comments · Fixed by #7546
Assignees
Labels
doc Documentation Python Affects Python cuDF API.

Comments

@galipremsagar
Copy link
Contributor

galipremsagar commented May 26, 2020

Report incorrect documentation

Location of incorrect documentation
This is a running issue containing a list of public-facing APIs not having code samples..

Describe the problems or issues found in the documentation
Series

abs
add
all
append
argsort
as_mask
astype
ceil
data
describe
diff
digitize
drop_duplicates
dropna
dtype
dtypes
empty
eq
factorize
fillna
floor
floordiv
from_categorical
from_masked_array
ge
gt
has_nulls
hash_encode
hash_values
iloc
index
isin
kurt
kurtosis
label_encoding
le
loc
lt
median
mod
mul
nans_to_nulls
ne
nlargest
nsmallest
nunique
one_hot_encoding
pow
quantile
radd
reindex
rename
replace
reset_index
reverse
rfloordiv
rmod
rmul
round
rpow
rsub
rtruediv
scale
set_index
set_mask
skew
sort_index
std
sub
take
to_array
to_dlpack
to_frame
to_gpu_array
tolist
to_string
truediv
unique
value_counts
values_to_string
var

Steps taken to verify documentation is incorrect
Verify cudf usage & pandas usage.

Suggested fix for documentation
Update their docs

@galipremsagar galipremsagar added doc Documentation Python Affects Python cuDF API. labels May 26, 2020
@galipremsagar galipremsagar self-assigned this Jun 3, 2020
@galipremsagar
Copy link
Contributor Author

This has been partially resolved in 0.15 on a rolling basis. Moving to 0.16

@kkraus14
Copy link
Collaborator

kkraus14 commented Feb 4, 2021

@galipremsagar once 0.18 release is done lets re-evaluate and update this list.

@galipremsagar
Copy link
Contributor Author

@galipremsagar once 0.18 release is done lets re-evaluate and update this list.

Sure

@galipremsagar
Copy link
Contributor Author

After re-evaluating what is not yet tackled, here are the list of APIs which need example additions:


abs
add
argsort
as_mask
astype
ceil
data
diff
digitize
drop_duplicates
dtype
dtypes
empty
eq
factorize
floor
floordiv
from_categorical
from_masked_array
ge
gt
has_nulls
hash_encode
hash_values
iloc
index
kurt
label_encoding
le
loc
lt
mod
mul
nans_to_nulls
ne
nlargest
nsmallest
nunique
one_hot_encoding
pow
quantile
radd
reindex
rename
reset_index
reverse
rmod
rmul
rpow
rsub
rtruediv
scale
set_index
set_mask
skew
sort_index
std
sub
take
to_array
to_dlpack
to_frame
to_gpu_array
to_string
truediv
unique
values_to_string
var

I'll close this issue in 0.19

rapids-bot bot pushed a commit that referenced this issue Mar 10, 2021
Fully resolves: #5290 

This PR:

- [x] Adds missing docstring examples in python public APIs.
- [x] Adds some missing alias APIs.
- [x] Fixes issue in `Series.take` where the index was not correctly being removed when `keep_index=False`.
- [x] **Removes** `Series.values_to_string`, this API seems to be have been touched 4-years ago and since we have removed support for iterating over GPU objects thought it is best to remove this API altogether.

Authors:
  - GALI PREM SAGAR (@galipremsagar)

Approvers:
  - Keith Kraus (@kkraus14)

URL: #7546
hyperbolic2346 pushed a commit to hyperbolic2346/cudf that referenced this issue Mar 25, 2021
Fully resolves: rapidsai#5290 

This PR:

- [x] Adds missing docstring examples in python public APIs.
- [x] Adds some missing alias APIs.
- [x] Fixes issue in `Series.take` where the index was not correctly being removed when `keep_index=False`.
- [x] **Removes** `Series.values_to_string`, this API seems to be have been touched 4-years ago and since we have removed support for iterating over GPU objects thought it is best to remove this API altogether.

Authors:
  - GALI PREM SAGAR (@galipremsagar)

Approvers:
  - Keith Kraus (@kkraus14)

URL: rapidsai#7546
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
doc Documentation Python Affects Python cuDF API.
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants