fix typos in README.md #504
Open
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
Signed-off-by: Andreas Zöller <83727040+TheManWhoStaresAtCode@users.noreply.github.com>
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.
Hi,
I was confused about the descriptions of the two parameters in particular in combination with the default values. For me it was totally unclear if e.g the bom serial number is included or excluded by default. I checked the code and it seems to be included by default.
My current understanding is that before my changes line 62 is a comment about the setting in line 63 and not a description of the parameter. In other words, given the
includeBomSerialNumberparameter is set tofalsethe serial number is excluded and therefore the comment reads Exclude instead of Include. However, this is in contrast to all other parameters where the description is independent of the example configuration.As the changes are simple I decided to directly create a pull request instead of opening an issue first.
Best regards
TheManWhoStaresAtCode