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

Remove unnecessary section #14341

Closed

Conversation

vyasr
Copy link
Contributor

@vyasr vyasr commented Oct 27, 2023

Description

Currently all the group pages in the documentation contained a "Detailed Description" section, but that section is always empty because we don't include additional information on each group. Removing that section should help clean things up.

Alternatively, we could write up a longer description for each group.

Checklist

  • I am familiar with the Contributing Guidelines.
  • New or existing tests cover these changes.
  • The documentation is up to date with these changes.

@vyasr vyasr added doc Documentation non-breaking Non-breaking change labels Oct 27, 2023
@vyasr vyasr self-assigned this Oct 27, 2023
@github-actions github-actions bot added the libcudf Affects libcudf (C++/CUDA) code. label Oct 27, 2023
@vyasr
Copy link
Contributor Author

vyasr commented Oct 27, 2023

Here's an example of the empty section in the hashing docs:
image

If we want to instead fill it in properly, we would need to add descriptions below each defgroup in https://github.com/rapidsai/cudf/blob/branch-23.12/cpp/include/doxygen_groups.h.

@vyasr vyasr force-pushed the feat/group_detailed_description branch from b289fd9 to b35ea73 Compare October 27, 2023 23:05
@vyasr vyasr force-pushed the feat/group_detailed_description branch from b35ea73 to 16c0c61 Compare October 27, 2023 23:08
@vyasr
Copy link
Contributor Author

vyasr commented Oct 27, 2023

This came up in rapidsai/rmm#1324. If we choose to fill out the docs for each group then we may want to reorder the layout so the summary comes above the ToC of members of the group.

@vyasr
Copy link
Contributor Author

vyasr commented Nov 2, 2023

At least in rmm we've decided to try and fill out the documentation for each group, so I'm closing this for now. If we go in the opposite direction for libcudf we can easily reopen this PR.

@vyasr vyasr closed this Nov 2, 2023
@davidwendt
Copy link
Contributor

At least in rmm we've decided to try and fill out the documentation for each group, so I'm closing this for now. If we go in the opposite direction for libcudf we can easily reopen this PR.

I will take a stab at documenting the sections.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
doc Documentation libcudf Affects libcudf (C++/CUDA) code. non-breaking Non-breaking change
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants