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] spell check fixes #10865

Merged
merged 3 commits into from
May 16, 2022
Merged

Conversation

karthikeyann
Copy link
Contributor

Ran spell check on comments on public facing APIs and fixed them.

@karthikeyann karthikeyann added 3 - Ready for Review Ready for review by team doc Documentation non-breaking Non-breaking change labels May 16, 2022
@karthikeyann karthikeyann self-assigned this May 16, 2022
@karthikeyann karthikeyann requested review from a team as code owners May 16, 2022 15:46
@github-actions github-actions bot added Python Affects Python cuDF API. libcudf Affects libcudf (C++/CUDA) code. labels May 16, 2022
Copy link
Contributor

@galipremsagar galipremsagar left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks @karthikeyann ! Approving this PR but would like to see the falsy comment considered as it is a pythonic term.

Also, could the spell checker that you are using be enforced in CI?

@@ -4506,7 +4506,7 @@ def from_pandas(cls, dataframe, nan_as_null=None):
Parameters
----------
dataframe : Pandas DataFrame object
A Pandads DataFrame object which has to be converted
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

dads 🤣

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Isn't it? 🤣

@@ -2044,7 +2044,7 @@ def searchsorted(
na_position=na_position,
)

# Retrun result as cupy array if the values is non-scalar
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

return + run = retrun 🤣

@@ -395,7 +395,7 @@ def concat(objs, axis=0, join="outer", ignore_index=False, sort=None):
axis=axis,
join=join,
ignore_index=ignore_index,
# Explicitly cast rather than relying on None being falsy.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We probably can keep this falsy: https://stackoverflow.com/a/39984051

Can we add falsy to the spell checker vocab?

@karthikeyann
Copy link
Contributor Author

Also, could the spell checker that you are using be enforced in CI?

spell checker right now does not understand inline or example code and argument names right now. So there are 100s of words which are mostly argument names and function names used in code. So, if add these exceptions, vocabulary will contain mostly arguments and function names. It does not look like a clean solution to be in CI right now. This CI will most likely fail when we add any example with new argument names in the docstring.
Right now, I am combing through 1000s of warnings and fixing the ones which looks wrong.

@codecov
Copy link

codecov bot commented May 16, 2022

Codecov Report

Merging #10865 (6d1f5b8) into branch-22.06 (6901b12) will increase coverage by 0.03%.
The diff coverage is n/a.

@@               Coverage Diff                @@
##           branch-22.06   #10865      +/-   ##
================================================
+ Coverage         86.29%   86.32%   +0.03%     
================================================
  Files               144      144              
  Lines             22656    22656              
================================================
+ Hits              19551    19558       +7     
+ Misses             3105     3098       -7     
Impacted Files Coverage Δ
python/cudf/cudf/core/column/string.py 88.78% <ø> (+0.12%) ⬆️
python/cudf/cudf/core/column/timedelta.py 90.75% <ø> (ø)
python/cudf/cudf/core/cut.py 82.69% <ø> (ø)
python/cudf/cudf/core/dataframe.py 93.78% <ø> (+0.04%) ⬆️
python/cudf/cudf/core/frame.py 93.41% <ø> (ø)
python/cudf/cudf/core/indexed_frame.py 91.70% <ø> (ø)
python/cudf/cudf/core/join/join.py 94.19% <ø> (ø)
python/cudf/cudf/core/multiindex.py 92.28% <ø> (ø)
python/cudf/cudf/core/series.py 95.17% <ø> (ø)
python/cudf/cudf/core/subword_tokenizer.py 75.00% <ø> (ø)
... and 10 more

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update ae2062e...6d1f5b8. Read the comment docs.

@galipremsagar galipremsagar added 5 - Ready to Merge Testing and reviews complete, ready to merge and removed 3 - Ready for Review Ready for review by team labels May 16, 2022
@galipremsagar
Copy link
Contributor

@gpucibot merge

@rapids-bot rapids-bot bot merged commit 6352b4e into rapidsai:branch-22.06 May 16, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
5 - Ready to Merge Testing and reviews complete, ready to merge doc Documentation libcudf Affects libcudf (C++/CUDA) code. non-breaking Non-breaking change Python Affects Python cuDF API.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants