docs: fix trainCase example output in README#133
Open
patrickwehbe wants to merge 1 commit into
Open
Conversation
trainCase("FooBARb") returns Foo-BA-Rb, not Foo-Ba-Rb. Without normalize the uppercase run is kept, as the note right below the example says (and as the splitByCase test for FooBARb shows). The old output was the normalize: true result.
|
No actionable comments were generated in the recent review. 🎉 ℹ️ Recent review info⚙️ Run configurationConfiguration used: defaults Review profile: CHILL Plan: Pro Run ID: 📒 Files selected for processing (1)
📝 WalkthroughWalkthroughThis change corrects a documentation typo in README.md, updating the expected output comment for the ChangesDocumentation Correction
Estimated code review effort: 1 (Trivial) | ~2 minutes 🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✨ Finishing Touches🧪 Generate unit tests (beta)
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
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.
The README example for
trainCaseshows the wrong output:The actual return value is
Foo-BA-Rb. Withoutnormalize, an uppercase run is preserved, which is exactly what the note right under the example states ("if an uppercase letter is followed by other uppercase letters they are preserved"), and what the existingsplitByCase("FooBARb")test (["Foo", "BA", "Rb"]) implies.Foo-Ba-Rbis the{ normalize: true }result, so the example was showing the normalized output for a non-normalized call.Verified by running the current source:
Docs-only change, no code touched.
Summary by CodeRabbit