Skip to content

[clang-tools-extra] Fix typos in Modularize.rst #99256

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 1 commit into from
Jul 17, 2024

Conversation

Abe149
Copy link
Contributor

@Abe149 Abe149 commented Jul 16, 2024

mainly, fixed “the Clang module mechanism doesn’t support headers the rely on other headers” => “the Clang module mechanism doesn’t support headers that rely on other headers”. [emphasis on “the” versus “that”]

…extra/docs/modularize.rst”

mainly, fixed “the Clang module mechanism doesn’t support headers the rely on other headers” => “the Clang module mechanism doesn’t support headers that rely on other headers”.  [emphasis on “the” versus “that”]
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 Jul 16, 2024

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

Author: Abe (Abe149)

Changes

mainly, fixed “the Clang module mechanism doesn’t support headers the rely on other headers” => “the Clang module mechanism doesn’t support headers that rely on other headers”. [emphasis on “the” versus “that”]


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

1 Files Affected:

  • (modified) clang-tools-extra/docs/modularize.rst (+2-2)
diff --git a/clang-tools-extra/docs/modularize.rst b/clang-tools-extra/docs/modularize.rst
index 64ca8c99d4e8e..97fd33b958650 100644
--- a/clang-tools-extra/docs/modularize.rst
+++ b/clang-tools-extra/docs/modularize.rst
@@ -254,8 +254,8 @@ For example, with the same header list from above::
   }
 
 Note that headers with dependents will be ignored with a warning, as the
-Clang module mechanism doesn't support headers the rely on other headers
-to be included first.
+Clang module mechanism doesn't support headers that rely on other headers
+being included first.
 
 The module map format defines some keywords which can't be used in module
 names. If a header has one of these names, an underscore ('_') will be

@Endilll Endilll requested review from AaronBallman and Endilll July 16, 2024 23:34
Copy link
Contributor

@Endilll Endilll left a comment

Choose a reason for hiding this comment

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

LGTM

@Endilll Endilll changed the title two-or-so tiny documentation fixes/improvements in “main/clang-tools-extra/docs/modularize.rst” [clang-tools-extra] Fix typos in Modularize.rst Jul 16, 2024
@Endilll
Copy link
Contributor

Endilll commented Jul 16, 2024

I took the liberty to rename the PR to something more typical for our repository. I hope you don't mind.

Copy link

⚠️ We detected that you are using a GitHub private e-mail address to contribute to the repo.
Please turn off Keep my email addresses private setting in your account.
See LLVM Discourse for more information.

@Endilll
Copy link
Contributor

Endilll commented Jul 16, 2024

We don't have to wait for Linux CI to finish to merge this, but private e-mail is an issue.

@Abe149
Copy link
Contributor Author

Abe149 commented Jul 17, 2024

We don't have to wait for Linux CI to finish to merge this, but private e-mail is an issue.

I think I fixed it. Please let me know if it`s good now or if I need to make more changes to my GitHub profile.

@DavidSpickett DavidSpickett merged commit 0905732 into llvm:main Jul 17, 2024
8 of 9 checks passed
Copy link

@Abe149 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!

@DavidSpickett
Copy link
Collaborator

DavidSpickett commented Jul 17, 2024

I saw your email in the merge box so I've gone ahead and landed it (I think the workflow that checks for a private email may only be re-run when the changes in the PR are updated).

Thanks for the contribution!

@Abe149
Copy link
Contributor Author

Abe149 commented Jul 17, 2024

Thanks for the contribution!

@DavidSpickett: you are welcome, and thanks for merging.

yuxuanchen1997 pushed a commit that referenced this pull request Jul 25, 2024
Summary:
mainly, fixed “the Clang module mechanism doesn’t support headers the
rely on other headers” => “the Clang module mechanism doesn’t support
headers that rely on other headers”. [emphasis on “the” versus “that”]

Test Plan: 

Reviewers: 

Subscribers: 

Tasks: 

Tags: 


Differential Revision: https://phabricator.intern.facebook.com/D60250885
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.

4 participants