[llvm] Proofread ProgrammersManual.rst #150787
Open
+95
−95
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
tgymnich
reviewed
Jul 26, 2025
llvm/docs/ProgrammersManual.rst
Outdated
| StringRef is ideal for passing simple strings around that are known to be live, | ||
| either because they are C string literals, std::string, a C array, or a | ||
| ``StringRef`` is ideal for passing simple strings around that are known to be live, | ||
| either because they are C string literals, ``std::string``, a C array, or a | ||
| SmallVector. Each of these cases has an efficient implicit conversion to |
There was a problem hiding this comment.
Suggested change
| SmallVector. Each of these cases has an efficient implicit conversion to | |
| ``SmallVector``. Each of these cases has an efficient implicit conversion to |
llvm/docs/ProgrammersManual.rst
Outdated
| StringRef is ideal for passing simple strings around that are known to be live, | ||
| either because they are C string literals, std::string, a C array, or a | ||
| ``StringRef`` is ideal for passing simple strings around that are known to be live, | ||
| either because they are C string literals, ``std::string``, a C array, or a | ||
| SmallVector. Each of these cases has an efficient implicit conversion to | ||
| StringRef, which doesn't result in a dynamic strlen being executed. |
There was a problem hiding this comment.
Suggested change
| StringRef, which doesn't result in a dynamic strlen being executed. | |
| ``StringRef``, which doesn't result in a dynamic ``strlen`` being executed. |
llvm/docs/ProgrammersManual.rst
Outdated
| StringRef is ideal for passing simple strings around that are known to be live, | ||
| either because they are C string literals, std::string, a C array, or a | ||
| ``StringRef`` is ideal for passing simple strings around that are known to be live, | ||
| either because they are C string literals, ``std::string``, a C array, or a | ||
| SmallVector. Each of these cases has an efficient implicit conversion to | ||
| StringRef, which doesn't result in a dynamic strlen being executed. | ||
|
|
||
| StringRef has a few major limitations which make more powerful string containers |
There was a problem hiding this comment.
Suggested change
| StringRef has a few major limitations which make more powerful string containers | |
| ``StringRef`` has a few major limitations which make more powerful string containers |
This patch only adds double backticks around code-related terms to facilitate the review process.
kazutakahirata
force-pushed
the
cleanup_20250726_proofread
branch
from
ce79249 to
2fe5f39
Compare
|
@tgymnich Thanks for the review! I've incorporated your suggestions and fixed a few more. Please take a look. Thanks! |
``SmallVector``s would trigger an error.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This patch only adds double backticks around code-related terms to
facilitate the review process.