change most headers to be about module features #797
Merged
Conversation
This file contains 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
Some headers could not be made about module features, and that's a strong signal that those sections should be removed.
fricklerhandwerk
approved these changes
Nov 17, 2023
| @@ -587,7 +585,7 @@ Make the following changes to `marker.nix`: | |||
| + }; | |||
| ``` | |||
|
|
|||
| ## Setting Option Values Within Other Modules | |||
| ## Defining Options in Other Modules | |||
There was a problem hiding this comment.
That would be the "old" nomenclature that trips people up. In think we should leave that as it was.
There was a problem hiding this comment.
Yeah so
Suggested change
| ## Defining Options in Other Modules | |
| ## Declaring Options in Other Modules |
There was a problem hiding this comment.
No, we're not declaring options in this section. But the first paragraph probably probably needs work.
Co-authored-by: Valentin Gagarin <[email protected]>
infinisil
added a commit
that referenced
this pull request
Nov 20, 2023
* Draft module system introduction tutorial * add intro/conclusion, rework prose, follow styleguide, clean diffs * Review pass * Apply suggestions from code review * fix whitespace * add some more motivation the each section * make scripts downloadable * address review comments * make script actually work ...hopefully. can't test it without Google API key * add file watching yes, this looks scary, and yes, it works. * update diff and wording * more notes on potential pitfalls * be explicit which `map` we mean * split nullable from default values * also wrap the geocode script * work through the tutorial to the end * add tutorial overview * `lib` is always passed * add separate section for `evalModules` and fix link * make option strucutre more self-explanatory * explain command line invocations * add note on incomplete reference documentation * add more highlight to the `config` distinction * fix parameter passing to the `./map` script * fix typo * fix wording * link to summer of nix * add missing word * link to Google Maps API docs * more explicit requirement * use correct module system terminology * Update source/tutorials/module-system/module-system.md * Apply suggestions from code review * whitespace * module-system.md: replace comments with captions * add missing lang for code-block * Update module system title * change most headers to be about module features (#797) * change most headers to be about module features Some headers could not be made about module features, and that's a strong signal that those sections should be removed. * Apply suggestions from code review * module-system.md: Fix header casing Co-authored-by: Alexander Groleau <[email protected]> Co-authored-by: asymmetric <[email protected]> Co-authored-by: Valentin Gagarin <[email protected]>
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.
Some headers could not be made about module features, and that's a strong signal that those sections should be removed, IMO.