Skip to content

Conversation

@mikomikotaishi
Copy link

This PR adds a link to the "Modules (C++)" page on Wikipedia, as per recommendation by another contributor.

@github-actions
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 llvmbot added clang Clang issues not falling into any other category clang:modules C++20 modules and Clang Header Modules labels Nov 23, 2025
@mikomikotaishi mikomikotaishi changed the title Add link to C++ modules Wikipedia page to docs [clang] [docs] Add link to C++ modules Wikipedia page to docs Nov 23, 2025
@llvmbot
Copy link
Member

llvmbot commented Nov 23, 2025

@llvm/pr-subscribers-clang-modules

Author: Miko (mikomikotaishi)

Changes

This PR adds a link to the "Modules (C++)" page on Wikipedia, as per recommendation by another contributor.


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

1 Files Affected:

  • (modified) clang/docs/StandardCPlusPlusModules.rst (+3)
diff --git a/clang/docs/StandardCPlusPlusModules.rst b/clang/docs/StandardCPlusPlusModules.rst
index 7155ad6cff83f..aa4a6812e0b1e 100644
--- a/clang/docs/StandardCPlusPlusModules.rst
+++ b/clang/docs/StandardCPlusPlusModules.rst
@@ -30,6 +30,9 @@ understand some terms and definitions for readers who are not familiar with the
 C++ feature. This document is not a tutorial on C++; it only introduces
 necessary concepts to better understand use of modules in a project.
 
+A high level overview of modules can be found on the
+`Modules (C++) <https://en.wikipedia.org/wiki/Modules_(C++)>`_ page on Wikipedia.
+
 Background and terminology
 --------------------------
 

@llvmbot
Copy link
Member

llvmbot commented Nov 23, 2025

@llvm/pr-subscribers-clang

Author: Miko (mikomikotaishi)

Changes

This PR adds a link to the "Modules (C++)" page on Wikipedia, as per recommendation by another contributor.


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

1 Files Affected:

  • (modified) clang/docs/StandardCPlusPlusModules.rst (+3)
diff --git a/clang/docs/StandardCPlusPlusModules.rst b/clang/docs/StandardCPlusPlusModules.rst
index 7155ad6cff83f..aa4a6812e0b1e 100644
--- a/clang/docs/StandardCPlusPlusModules.rst
+++ b/clang/docs/StandardCPlusPlusModules.rst
@@ -30,6 +30,9 @@ understand some terms and definitions for readers who are not familiar with the
 C++ feature. This document is not a tutorial on C++; it only introduces
 necessary concepts to better understand use of modules in a project.
 
+A high level overview of modules can be found on the
+`Modules (C++) <https://en.wikipedia.org/wiki/Modules_(C++)>`_ page on Wikipedia.
+
 Background and terminology
 --------------------------
 

@mikomikotaishi mikomikotaishi changed the title [clang] [docs] Add link to C++ modules Wikipedia page to docs [clang][docs] Add link to C++ modules Wikipedia page to docs Nov 23, 2025
@mikomikotaishi
Copy link
Author

@durga4github @schwarzschild-radius pinging you because the most recent doc change I found (#168716) added you as reviewers.

Copy link
Member

@ChuanqiXu9 ChuanqiXu9 left a comment

Choose a reason for hiding this comment

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

I don't feel this is too meaningful...

@mikomikotaishi
Copy link
Author

I don't feel this is too meaningful...

But you were the one who suggested adding it to that page.

@ChuanqiXu9
Copy link
Member

I don't feel this is too meaningful...

But you were the one who suggested adding it to that page.

Sorry, I didn't understand what you say in the first place. I thought you want to describe how to provide a reduced reproducer.

@mikomikotaishi
Copy link
Author

If there is concern that its location on the page gives too much priority to it, I alternatively propose to put it in a "further reading" section, similar to Debugging C++ Coroutines page.

@mikomikotaishi
Copy link
Author

@AaronBallman Pinging you as per recommendation

@cor3ntin
Copy link
Contributor

if we wanted to link external documentation (we usually do not), https://en.cppreference.com/w/cpp/language/modules.html would be a better resource

@mikomikotaishi
Copy link
Author

mikomikotaishi commented Nov 27, 2025

I gave an example of a page that cites external sites, and cppreference is updated far less frequently (it has been frozen for half a year now). I'm not inherently more in favour of citing one source (Wikipedia) over the other (cppreference), if it ends up we insist on using cppreference I haven't got a problem with that, but from a utility and maintenance point of view it does look like the Wikipedia one is more consistently updated.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

clang:modules C++20 modules and Clang Header Modules clang Clang issues not falling into any other category

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants