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

Fix documentation issues [skip ci] #10306

Merged
merged 1 commit into from
Feb 16, 2022
Merged

Fix documentation issues [skip ci] #10306

merged 1 commit into from
Feb 16, 2022

Conversation

ajschmidt8
Copy link
Member

This PR addresses some issues that were causing documentation builds to fail. Namely:

  1. Changing all Example headers to Examples (Examples is correct, Example is incorrect. see: https://numpydoc.readthedocs.io/en/latest/format.html#examples)
  2. Ensuring all headers have correct underline length

@ajschmidt8
Fix documentation issues
42dde2e 
This PR addresses some issues that were causing documentation builds to fail. Namely:

1. Changing all `Example` headers to `Examples`
2. Ensuring all headers have correct underline length
@ajschmidt8 ajschmidt8 requested a review from a team as a code owner February 16, 2022 14:59
@github-actions github-actions bot added the Python Affects Python cuDF API. label Feb 16, 2022
@ajschmidt8 ajschmidt8 added doc Documentation non-breaking Non-breaking change and removed Python Affects Python cuDF API. labels Feb 16, 2022
@galipremsagar
Copy link
Contributor

@gpucibot merge

1 similar comment
@ajschmidt8
Copy link
Member Author

@gpucibot merge

@rapids-bot rapids-bot bot merged commit 4474d9e into rapidsai:branch-22.04 Feb 16, 2022
@ajschmidt8 ajschmidt8 deleted the fix-docs branch February 16, 2022 15:00
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@galipremsagar galipremsagar galipremsagar approved these changes

@trxcllnt trxcllnt Awaiting requested review from trxcllnt trxcllnt is a code owner automatically assigned from rapidsai/cudf-python-codeowners

@rgsl888prabhu rgsl888prabhu Awaiting requested review from rgsl888prabhu rgsl888prabhu is a code owner automatically assigned from rapidsai/cudf-python-codeowners

Assignees
No one assigned
Labels
doc Documentation non-breaking Non-breaking change
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@ajschmidt8 @galipremsagar