docs: Add clarification about all lowercase custom data fields #2011
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
Hi, I'm new to chezmoi and started to look into templates. I've spent quite some time to figure out why I could not get custom variables in the `data` section of the config to work until I realized that I've stumbled upon twpayne#463. I propose to add a hint or disclaimer to the documentation here to make it easier for newcomers to spot this pitfall (and avoid it). Please let me know if I need to change or update anything.
|
This is great, thank you!
Such a change would be welcome too :) |
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
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.
Hi,
I'm new to chezmoi and started to look into templates. I've spent quite some time to figure out why I could not get custom variables in the
datasection of the config to work until I realized that I've stumbled upon #463.I propose to add a hint or disclaimer to the documentation here to make it easier for newcomers to spot this pitfall (and avoid it). The FAQ added in #671 contains a reference already, but I only found it by backtracking from the issue.
Maybe adding the hint (also) to User Guide > Templating would also help?
Please let me know if I need to change or update anything.