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

Fix sphinx/jupyter heading issue in UDF notebook #10690

Merged

Conversation

brandon-b-miller
Copy link
Contributor

Fixes an issue where sphinx was reading the #'s in the UDF guide markdown cells as section headings causing strange effects in the docs main index page.

@brandon-b-miller brandon-b-miller added 3 - Ready for Review Ready for review by team doc Documentation Python Affects Python cuDF API. non-breaking Non-breaking change labels Apr 20, 2022
@review-notebook-app
Copy link

Check out this pull request on  ReviewNB

See visual diffs & provide feedback on Jupyter Notebooks.


Powered by ReviewNB

@github-actions github-actions bot removed the Python Affects Python cuDF API. label Apr 20, 2022
@shwina
Copy link
Contributor

shwina commented Apr 20, 2022

@gpucibot merge

Comment on lines +7 to +8
"Overview of User Defined Functions with cuDF\n",
"===================================="
Copy link
Contributor

Choose a reason for hiding this comment

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

I think the heading and the line below need to be of equal length, or else Sphinx throws warnings. Can you fix these and/or verify that no warnings are thrown?

Suggested change
"Overview of User Defined Functions with cuDF\n",
"===================================="
"Overview of User Defined Functions with cuDF\n",
"============================================"

Copy link
Contributor

Choose a reason for hiding this comment

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

(I might be a little late commenting after Ashwin directed this PR to merge.)

Copy link
Contributor

Choose a reason for hiding this comment

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

Some of this is going to be fixed in #10685 anyway.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I'm not getting warnings locally. I think it's because matching the character lengths is just a minimum, but I'm checking to make sure.

@codecov
Copy link

codecov bot commented Apr 20, 2022

Codecov Report

Merging #10690 (9bbf119) into branch-22.06 (65b1cbd) will increase coverage by 0.03%.
The diff coverage is n/a.

@@               Coverage Diff                @@
##           branch-22.06   #10690      +/-   ##
================================================
+ Coverage         86.35%   86.38%   +0.03%     
================================================
  Files               142      142              
  Lines             22335    22335              
================================================
+ Hits              19287    19294       +7     
+ Misses             3048     3041       -7     
Impacted Files Coverage Δ
python/cudf/cudf/core/column/string.py 89.22% <0.00%> (+0.12%) ⬆️
python/cudf/cudf/core/groupby/groupby.py 91.64% <0.00%> (+0.23%) ⬆️
python/cudf/cudf/core/column/numerical.py 96.17% <0.00%> (+0.29%) ⬆️
python/cudf/cudf/core/tools/datetimes.py 84.49% <0.00%> (+0.30%) ⬆️
python/cudf/cudf/core/column/lists.py 92.79% <0.00%> (+1.27%) ⬆️

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 65b1cbd...9bbf119. Read the comment docs.

@rapids-bot rapids-bot bot merged commit 5f6b70a into rapidsai:branch-22.06 Apr 20, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
3 - Ready for Review Ready for review by team doc Documentation non-breaking Non-breaking change
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants