add LoaderOptions doc to README #396
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
cowtowncoder
reviewed
Mar 6, 2023
yaml/README.md
Outdated
| @@ -60,7 +60,16 @@ while (parser.nextToken() != null) { | |||
| Most configuration is applied during mapper instance configuration, through | |||
| `YAMLMapper.Builder`, similar to how JSON-based plain `ObjectMapper` is configured. | |||
|
|
|||
| ## Known problems | |||
| If you are parsing YAML, it is recommended that you consider configuring the | |||
There was a problem hiding this comment.
I think this must note version this applicable to (2.14+), otherwise we get questions on why settings are missing.
Also I am not 100% sure it is really recommended in the sense that the defaults should be fine for most users?
Maybe change wording to suggest it may be necessary when processing larger content or something.
I do not think it is something that really affects vast majority of users.
There was a problem hiding this comment.
I refactored the doc to remove the word 'recommend' and also highlighted that this is about v2.14 and above
cowtowncoder
approved these changes
Mar 7, 2023
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.