-
Notifications
You must be signed in to change notification settings - Fork 16
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Fix broken comment references #89
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM, and thanks!
lib/src/characters.dart
Outdated
/// using [CharacterRange.movePrevious], | ||
/// as well as controlling the iteration in more detail. | ||
/// Allows iterating the characters of [string] backwards using | ||
/// [CharacterRange.moveBack], as well as controlling the iteration in more |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I'd still keep the line break after the comma, instead of splitting the following clause on two lines.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Done
/// Uses information stored in [_state] for cases where the next | ||
/// character has already been seen. | ||
/// Uses information stored in the state for cases where the next character | ||
/// has already been seen. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I'm not even sure which state that is. Maybe the entire paragraph is garbage.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
😁
As a drive by comment, if we update the dep on |
These broken comment references are all highlighted by the
comment_references
linter rule, and thedart doc
tool.In a few cases, I tried to find a replacement, but I also had to just abandon some
[]
references as I could not tell what the current equivalent is, for what they (presumably) previously referred to.Let me know if there is better replacement text. Let me know if I should bump the version in CHANGELOG and pubspec files.
Contribution guidelines:
dart format
.Note that many Dart repos have a weekly cadence for reviewing PRs - please allow for some latency before initial review feedback.