Improve comment on how to avoid duplication from default.includes. #74
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
There was a problem hiding this comment.
Pull Request Overview
This PR improves documentation on avoiding configuration duplication in default includes by adding a detailed explanatory comment with concrete examples. The changes also refactor existing code to follow the recommended pattern.
- Adds comprehensive documentation explaining how to prevent config duplication when using fully parametric functions in defaults
- Refactors hostname configuration to use
den.lib.take.exactlyfor proper scoping - Simplifies
vm-bootableandigloo.includesaspects by removing redundant hostname settings
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| (if config ? _module.args.CI then den.aspects.ci-no-boot else { }) | ||
|
|
||
| # NOTE: be cautious when adding fully parametric functions to defaults. | ||
| # defaults are included on EVERY host/user/home, and IF you are not careful |
There was a problem hiding this comment.
[nitpick] Grammatical issue: "IF you are not careful" should use lowercase "if" since it's not at the beginning of a sentence and doesn't need emphasis. The capitalization is inconsistent with standard English writing conventions.
Suggested change
| # defaults are included on EVERY host/user/home, and IF you are not careful | |
| # defaults are included on EVERY host/user/home, and if you are not careful |
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.
No description provided.