-
Notifications
You must be signed in to change notification settings - Fork 77
Use markdown lists in doc comments #2288
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
base: main
Are you sure you want to change the base?
Conversation
Package publishing
Documentation at https://github.com/dart-lang/ecosystem/wiki/Publishing-automation. |
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.
Code Review
This pull request improves the documentation for the Event class constructors by converting parameter descriptions into markdown lists. This change will make the parameters more scannable in the generated documentation, which is a great improvement for readability. The changes also include several nice stylistic cleanups, such as standardizing on JSON-encoded and Boolean, and improving comment formatting. I found one minor typo in the documentation which I've commented on. Overall, this is a solid improvement to the codebase's documentation.
| /// [podCount] - the number of plugins compatible with CocoaPods. This is less | ||
| /// than or equal to [podCount]. | ||
| /// * [podCount] - the number of plugins compatible with CocoaPods. This is | ||
| /// less than or equal to [podCount]. |
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.
There appears to be a small typo in the documentation for podCount. It states that podCount is less than or equal to [podCount], which is self-referential. For consistency with the documentation for swiftPackageCount, this should probably refer to [pluginCount].
| /// less than or equal to [podCount]. | |
| /// less than or equal to [pluginCount]. |
PR HealthLicense Headers ✔️
All source files should start with a license header. Unrelated files missing license headers
This check can be disabled by tagging the PR with
API leaks
|
| Package | Leaked API symbol | Leaking sources |
|---|---|---|
| unified_analytics | Condition | survey_handler.dart::Survey::conditionList survey_handler.dart::Survey::new::conditionList |
| unified_analytics | PersistedSurvey | survey_handler.dart::SurveyHandler::fetchPersistedSurveys |
| unified_analytics | GAClient | analytics.dart::Analytics::fake::gaClient analytics.dart::AnalyticsImpl::new::gaClient |
| unified_analytics | UserProperty | analytics.dart::FakeAnalytics::userProperty |
This check can be disabled by tagging the PR with skip-leaking-check.
Breaking changes ⚠️
| Package | Change | Current Version | New Version | Needed Version | Looking good? |
|---|---|---|---|---|---|
| unified_analytics | Non-Breaking | 8.0.10 | 8.0.12 | 8.1.0 Got "8.0.12" expected >= "8.1.0" (non-breaking changes) |
This check can be disabled by tagging the PR with skip-breaking-check.
Coverage ✔️
| File | Coverage |
|---|---|
| pkgs/unified_analytics/lib/src/event.dart | 💚 98 % |
This check for test coverage is informational (issues shown here will not fail the PR).
This check can be disabled by tagging the PR with skip-coverage-check.
7d539df to
ca2df33
Compare
I notice that there was an intention for the parameter documentations to be indented in order to make the parameter names vertically scannable. But no markdown lists were used, so they are not vertically scannable in the generated documentation.
This change makes each parameter's documentation into a list item. We could go the other way and remove all of the indented wrapped lines, and just write the text as standard paragraphs.