Skip to content

[clangd][docs] Fix incorrect docstring for header-insertion "Never" #135921

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

Conversation

MythreyaK
Copy link
Contributor

Docstring fix for changes introduced in PR #128503

@llvmbot
Copy link
Member

llvmbot commented Apr 16, 2025

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

@llvm/pr-subscribers-clangd

Author: Mythreya (MythreyaK)

Changes

Docstring fix for changes introduced in PR #128503


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

1 Files Affected:

  • (modified) clang-tools-extra/clangd/ConfigFragment.h (+1-1)
diff --git a/clang-tools-extra/clangd/ConfigFragment.h b/clang-tools-extra/clangd/ConfigFragment.h
index f05ed4d1acdfc..2363b483ab96d 100644
--- a/clang-tools-extra/clangd/ConfigFragment.h
+++ b/clang-tools-extra/clangd/ConfigFragment.h
@@ -347,7 +347,7 @@ struct Fragment {
     ///   "IWYU": Include what you use. Insert the owning header for top-level
     ///     symbols, unless the header is already directly included or the
     ///     symbol is forward-declared
-    ///   "NeverInsert": Never insert headers
+    ///   "Never": Never insert headers
     std::optional<Located<std::string>> HeaderInsertion;
   };
   CompletionBlock Completion;

Copy link
Member

@kadircet kadircet left a comment

Choose a reason for hiding this comment

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

thanks!

@kadircet
Copy link
Member

btw do you have commit access or should I merge ?

@MythreyaK
Copy link
Contributor Author

I don't think I do, you'll probably need to merge it if it looks good

@kadircet kadircet merged commit a56f966 into llvm:main Apr 16, 2025
12 of 13 checks passed
@MythreyaK MythreyaK deleted the MythreyaK/clangd-doc-fix-header-insertion-never branch April 16, 2025 07:01
var-const pushed a commit to ldionne/llvm-project that referenced this pull request Apr 17, 2025
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.

3 participants