Skip to content

[clang-tidy] [docs] Replace _not_ in reserved-identifier.rst with *not* #112162

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 3 commits into from
Oct 17, 2024

Conversation

njriasan
Copy link
Contributor

Fixes a documentation formatting error where _not_ was used which has no special meaning in markdown and replaces it with *not*.

Closes #111691

Copy link

Thank you for submitting a Pull Request (PR) to the LLVM Project!

This PR will be automatically labeled and the relevant teams will be notified.

If you wish to, you can add reviewers by using the "Reviewers" section on this page.

If this is not working for you, it is probably because you do not have write permissions for the repository. In which case you can instead tag reviewers by name in a comment by using @ followed by their GitHub username.

If you have received no comments on your PR for a week, you can request a review by "ping"ing the PR by adding a comment “Ping”. The common courtesy "ping" rate is once a week. Please remember that you are asking for valuable time from other developers.

If you have further questions, they may be answered by the LLVM GitHub User Guide.

You can also ask questions in a comment on this PR, on the LLVM Discord or on the forums.

@llvmbot
Copy link
Member

llvmbot commented Oct 14, 2024

@llvm/pr-subscribers-clang-tools-extra

@llvm/pr-subscribers-clang-tidy

Author: Nick Riasanovsky (njriasan)

Changes

Fixes a documentation formatting error where _not_ was used which has no special meaning in markdown and replaces it with *not*.

Closes #111691


Full diff: https://github.com/llvm/llvm-project/pull/112162.diff

1 Files Affected:

  • (modified) clang-tools-extra/docs/clang-tidy/checks/bugprone/reserved-identifier.rst (+1-1)
diff --git a/clang-tools-extra/docs/clang-tidy/checks/bugprone/reserved-identifier.rst b/clang-tools-extra/docs/clang-tidy/checks/bugprone/reserved-identifier.rst
index a498ff8409af3a..3f6cee9b3bb5aa 100644
--- a/clang-tools-extra/docs/clang-tidy/checks/bugprone/reserved-identifier.rst
+++ b/clang-tools-extra/docs/clang-tidy/checks/bugprone/reserved-identifier.rst
@@ -28,7 +28,7 @@ Violating the naming rules above results in undefined behavior.
   int _g(); // disallowed in global namespace only
 
 The check can also be inverted, i.e. it can be configured to flag any
-identifier that is _not_ a reserved identifier. This mode is for use by e.g.
+identifier that is *not* a reserved identifier. This mode is for use by e.g.
 standard library implementors, to ensure they don't infringe on the user
 namespace.
 

@carlosgalvezp
Copy link
Contributor

@njriasan Thanks for the contribution! I see the commit message would include this:

Co-authored-by: Nicholas Riasanovsky <[email protected]>

Do you want to keep that?

@njriasan
Copy link
Contributor Author

@njriasan Thanks for the contribution! I see the commit message would include this:

Co-authored-by: Nicholas Riasanovsky <[email protected]>

Do you want to keep that?

@carlosgalvezp That message is because I got a new computer and it wasn't properly setup yet. I would like to remove it if possible. What is the process for updating a commit message in this repo? Should I just force push a modified message to this branch?

@carlosgalvezp
Copy link
Contributor

@carlosgalvezp That message is because I got a new computer and it wasn't properly setup yet. I would like to remove it if possible. What is the process for updating a commit message in this repo? Should I just force push a modified message to this branch?

I'm not 100% sure but please do try a force-push to change the commit message. Otherwise I can remove it for you before merging.

@njriasan njriasan force-pushed the njriasan/clang_tidy_docs_fix branch from 8b954f0 to e5a70cb Compare October 14, 2024 19:03
@njriasan
Copy link
Contributor Author

@carlosgalvezp I think the force push fixed it. Could you confirm that you no longer see the second author? Thanks.

@nicovank
Copy link
Contributor

Rebase past 3484ed9 for green CI.

@nicovank nicovank merged commit 6d7712a into llvm:main Oct 17, 2024
9 checks passed
Copy link

@njriasan Congratulations on having your first Pull Request (PR) merged into the LLVM Project!

Your changes will be combined with recent changes from other authors, then tested by our build bots. If there is a problem with a build, you may receive a report in an email or a comment on this PR.

Please check whether problems have been caused by your change specifically, as the builds can include changes from many authors. It is not uncommon for your change to be included in a build that fails due to someone else's changes, or infrastructure issues.

How to do this, and the rest of the post-merge process, is covered in detail here.

If your change does cause a problem, it may be reverted, or you can revert it yourself. This is a normal part of LLVM development. You can fix your changes and open a new PR to merge them again.

If you don't get any reports, no action is required from you. Your changes are working as expected, well done!

@njriasan njriasan deleted the njriasan/clang_tidy_docs_fix branch October 17, 2024 16:43
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Documentation formatting error
4 participants