docs: explain how strip_components works for english readme for now#224
Open
cmgriffing wants to merge 1 commit intoappleboy:masterfrom
Open
docs: explain how strip_components works for english readme for now#224cmgriffing wants to merge 1 commit intoappleboy:masterfrom
cmgriffing wants to merge 1 commit intoappleboy:masterfrom
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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 think the README could be more explicit about what value type is expected as well as a security note that it is an amount of components to strip.
I'm happy to edit this as needed, but I think it would prevent some users from the inevitable bad commit in which they try to pass "true" instead of a number value.