Skip to content
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

Merged
merged 2 commits into from
Oct 13, 2023
Merged

Fix broken comment references #89

merged 2 commits into from
Oct 13, 2023

Conversation

srawlins
Copy link
Member

These broken comment references are all highlighted by the comment_references linter rule, and the dart 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.


  • I’ve reviewed the contributor guide and applied the relevant portions to this PR.
Contribution guidelines:

Note that many Dart repos have a weekly cadence for reviewing PRs - please allow for some latency before initial review feedback.

Copy link
Member

@lrhn lrhn left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM, and thanks!

/// 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
Copy link
Member

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.

Copy link
Member Author

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.
Copy link
Member

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.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

😁

@devoncarew
Copy link
Member

As a drive by comment, if we update the dep on dart_flutter_team_lints to ^2.0.0, it'll turn the comment directives lint on.

@srawlins srawlins merged commit bca1288 into master Oct 13, 2023
9 checks passed
@srawlins srawlins deleted the fix-references branch October 13, 2023 17:12
@srawlins srawlins restored the fix-references branch October 13, 2023 17:13
@srawlins srawlins deleted the fix-references branch October 13, 2023 17:13
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants