-
Notifications
You must be signed in to change notification settings - Fork 58
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Add @TomlIgnore and @TomlComment annotations #65
Open
ErdbeerbaerLP
wants to merge
18
commits into
mwanji:wip
Choose a base branch
from
ErdbeerbaerLP:wip
base: wip
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
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
I honestly would love for this PR to get merged as it would be great to have comments thru annotations. It seems to work for my case as i'm currently using it to generate config files for a game without issue |
I'd like to see this merged also, I'm writing a config generator for InfluxData Telegraf Monitoring agent, and these would help a lot. |
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.
I added two annotations to this library:
@TomlIgnore
Fields with this annotation will not get written to the toml file.
@TomlComment
When adding this annotation to an field, the value of this annotation will get written as comment above the toml entry
Example:
Written to toml file using
TomlWriter
:Need another use example? I already used it here to create an configuration file