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 doc comments #256

Merged
merged 1 commit into from
Aug 29, 2024
Merged

Fix doc comments #256

merged 1 commit into from
Aug 29, 2024

Commits on Aug 29, 2024

  1. Fix doc comments

    Update comments that set off a false positive in the
    `unintended_html_in_doc_comment` lint. For references to core Dart
    types with generics, replace the square braces with backticks since it
    is useful to constantly link them.
    
    For the comments that are edited, and a few nearby, update for style:
    
    - Separate out a header as it's own paragraph.
    - Reduce repetitive phrasing and redundant links to the same arguments.
    
    Use a trailing comma for a long argument list, and re-order the
    arguments so that the always-useful arguments are at the top, and the
    arguments only pertaining to certain uses follow.
    natebosch committed Aug 29, 2024
    Configuration menu
    Copy the full SHA
    5e79c11 View commit details
    Browse the repository at this point in the history