Comment rules deep clean - #182
Open
alex-rawlings-yyc wants to merge 12 commits into
Open
Conversation
Drop the repeated @param verseBook/@param delta/@returns boilerplate across the segmentation transforms, and condense how-narration in the identity helpers while keeping the normalization and dedupe rationale.
Drop @param/@returns that restate the signature, keeping only the tags that carry real constraints (pre-sort order, axis-aligned waypoints, radius clamping), and trim how-narration from the arc-routing docs.
Drop @param/@returns that restate the signature, including the args-destructuring blocks that duplicated the args interfaces' own field docs. Keep the tags whose values carry semantics the types don't (force/isVerify, deps, edge).
Remove the @param state/@param action boilerplate repeated across every reducer and selector, and the @returns that restated the summary directly above them. Fold the few real details (stable empty array, blank-clears-gloss, per-morpheme writing system) into the prose. Keep every @throws and the storage tags carrying ENOENT, ordering, and null-to-clear semantics.
Drop the '@param props - Component props' umbrella repeated across 47 component docs and the @returns that only restated the rendered markup, keeping the ones that express conditional absence or real semantics. Delete the single-line @file banners and fold the substantive multi-line ones (Alt-context isolation, the strip context's deliberate exclusions, the dropdown's portaling, editor-vs-display for morphemes) into the symbols they describe.
Drop the '@param page The Playwright Page' boilerplate repeated across 19 helpers and the '@returns Nothing.' tags, and normalize the remaining @param tags to TSDoc dash form to match the rest of the repo. Keep the @returns that define each helper's postcondition, since 'resolved' is not obvious from Promise<void>.
|
Important Review skippedToo many files! This PR contains 144 files, which is 44 over the limit of 100. To get a review, narrow the scope: Upgrade to a paid plan to raise the limit. This review couldn't start because sufficient usage credits or metered capacity aren't available. Add credits or update usage-based reviews in the billing tab, then retry. ⚙️ Run configurationConfiguration used: defaults Review profile: CHILL Plan: Pro Plus Run ID: 📒 Files selected for processing (144)
You can disable this status message by setting the 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 |
alex-rawlings-yyc
added
the
up next
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.
This change is