Conversation
Add a short overview at the top of the module reference page so readers understand the term before the generated module list. Fixes canonicalGH-4407
github-actions
Bot
added
the
documentation
holmanb
requested changes
Sep 28, 2026
Comment on lines
+10
to
+11
| organized under a top-level key such as ``packages`` or ``runcmd``. The | ||
| code for each module lives under :file:`cloudinit/config/` in a ``cc_*.py`` file. |
Member
There was a problem hiding this comment.
The code location is not something that something that the user needs to know about.
Author
There was a problem hiding this comment.
Thanks for the feedback. I removed the line.
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
Proposed Commit Message
docs(modules): define what a module is
Add a short overview at the top of the module reference page so
readers understand the term before the generated module list.
Fixes GH-4407
Additional Context
Fixes #4407. Adds a "What is a module?" section at the top of
doc/rtd/reference/modules.rst, per maintainer feedback on the issue.Test Steps
Docs-only change. No runtime behavior change.
Optional:
tox -e docand opendoc/rtd_html/reference/modules.html.Merge type