Skip to content

Clarify @brief tag as description/title on documentation guide #18515

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

Merged
merged 2 commits into from
Apr 21, 2025

Conversation

davidwendt
Copy link
Contributor

Description

Simple clarification that the @brief doxygen tag in the C++ documentation does not require a period unless the accompanying text is actually a sentence. This helps keep the documentation consistent across the repo.

Checklist

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

@davidwendt davidwendt added 3 - Ready for Review Ready for review by team doc Documentation libcudf Affects libcudf (C++/CUDA) code. non-breaking Non-breaking change labels Apr 17, 2025
@davidwendt davidwendt self-assigned this Apr 17, 2025
@davidwendt davidwendt requested a review from a team as a code owner April 17, 2025 17:41
@davidwendt davidwendt requested review from mythrocks and vuule April 17, 2025 17:41
@davidwendt
Copy link
Contributor Author

/merge

@rapids-bot rapids-bot bot merged commit e1db899 into rapidsai:branch-25.06 Apr 21, 2025
112 checks passed
@davidwendt davidwendt deleted the no-sentences branch April 21, 2025 17:58
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 libcudf Affects libcudf (C++/CUDA) code. non-breaking Non-breaking change
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants