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

docs: format docs #63

Merged
merged 1 commit into from
Nov 19, 2023
Merged

docs: format docs #63

merged 1 commit into from
Nov 19, 2023

Conversation

ronnnnn
Copy link
Owner

@ronnnnn ronnnnn commented Nov 19, 2023

Overview

format API docs and README.

Feature type

  • Lint Rule
  • Quick fix
  • Assist
  • Other (Update docs, Configure CI, etc...)

@ronnnnn ronnnnn added the docs Improvements or additions to documentation label Nov 19, 2023
Copy link
Contributor

github-actions bot commented Nov 19, 2023

Image description CodeRabbit

Walkthrough

This pull request primarily focuses on enhancing the readability and consistency of API documentation and README files. It provides detailed information about various lint rules, their target SDK versions, rule types, maturity levels, and quick fixes. The changes are purely cosmetic and do not affect the underlying logic or functionality of the code.

Changes

Files Summary
packages/nilts/README.md Updated the formatting and details for improved readability and consistency.
packages/nilts/lib/src/lints/defined_void_callback_type.dart
packages/nilts/lib/src/lints/fixed_text_scale_rich_text.dart
packages/nilts/lib/src/lints/flaky_tests_with_set_up_all.dart
packages/nilts/lib/src/lints/no_support_multi_text_direction.dart
packages/nilts/lib/src/lints/shrink_wrapped_scroll_view.dart
packages/nilts/lib/src/lints/unnecessary_rebuilds_from_media_query.dart
Enhanced the metadata section for each lint rule, including target SDK version, rule type, maturity level, and quick fix status. Adjusted text formatting and alignment for better readability.

Uplevel your code reviews with CodeRabbit Pro

CodeRabbit Pro

If you like this project, please support us by purchasing the Pro version. The Pro version has advanced context, superior noise reduction and several proprietary improvements compared to the open source version. Moreover, CodeRabbit Pro is free for open source projects.

Copy link
Contributor

@github-actions github-actions bot left a comment

Choose a reason for hiding this comment

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

Image description CodeRabbit

Commits Files that changed from the base of the PR and between 670de15 and f92f5c4 commits.
Files selected (7)
  • packages/nilts/README.md (6)
  • packages/nilts/lib/src/lints/defined_void_callback_type.dart (1)
  • packages/nilts/lib/src/lints/fixed_text_scale_rich_text.dart (1)
  • packages/nilts/lib/src/lints/flaky_tests_with_set_up_all.dart (1)
  • packages/nilts/lib/src/lints/no_support_multi_text_direction.dart (1)
  • packages/nilts/lib/src/lints/shrink_wrapped_scroll_view.dart (1)
  • packages/nilts/lib/src/lints/unnecessary_rebuilds_from_media_query.dart (1)
Files skipped from review due to trivial changes (6)
  • packages/nilts/lib/src/lints/defined_void_callback_type.dart
  • packages/nilts/lib/src/lints/fixed_text_scale_rich_text.dart
  • packages/nilts/lib/src/lints/flaky_tests_with_set_up_all.dart
  • packages/nilts/lib/src/lints/no_support_multi_text_direction.dart
  • packages/nilts/lib/src/lints/shrink_wrapped_scroll_view.dart
  • packages/nilts/lib/src/lints/unnecessary_rebuilds_from_media_query.dart
Review comments generated (6)
  • Review: 0
  • LGTM: 6

Tips

Chat with Image description CodeRabbit Bot (@coderabbitai)

  • Reply on review comments left by this bot to ask follow-up questions. A review comment is a comment on a diff or a file.
  • Invite the bot into a review comment chain by tagging @coderabbitai in a reply.

Code suggestions

  • The bot may make code suggestions, but please review them carefully before committing since the line number ranges may be misaligned.
  • You can edit the comment made by the bot and manually tweak the suggestion if it is slightly off.

Pausing incremental reviews

  • Add @coderabbitai: ignore anywhere in the PR description to pause further reviews from the bot.

@ronnnnn ronnnnn merged commit 48f2b2a into main Nov 19, 2023
4 checks passed
@ronnnnn ronnnnn deleted the docs-pretty-docs branch November 19, 2023 05:10
@github-actions github-actions bot mentioned this pull request Sep 6, 2024
@github-actions github-actions bot mentioned this pull request Nov 3, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant