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.

Sign up for GitHub

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

Jump to bottom

Extend public member documentation #381

Merged
merged 6 commits into from Apr 27, 2022
Merged

Extend public member documentation #381

merged 6 commits into from Apr 27, 2022

Conversation

ikurek
Copy link
Contributor

@ikurek ikurek commented Apr 26, 2022

This should close #380. I've extended the dartdoc comments to reduce the number of lint warnings and added ignore: public_member_api_docs annotations to some classes that do not require doc comments

@ikurek ikurek added the documentation Improvements or additions to public interface documentation (API reference or readme). label Apr 26, 2022
@ikurek ikurek self-assigned this Apr 26, 2022
@github-actions github-actions bot temporarily deployed to staging/pull/381/dartdoc April 26, 2022 15:18 Inactive
KacperKluka
KacperKluka reviewed Apr 27, 2022
View reviewed changes
Copy link

@KacperKluka KacperKluka left a comment

Choose a reason for hiding this comment

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

Looks good but I have a few suggestions 😉

lib/src/platform/src/realtime/realtime_channel.dart Show resolved Hide resolved
lib/src/platform/src/push_notification_events_internal.dart Outdated Show resolved Hide resolved
lib/src/platform/src/push_activation_events_internal.dart Show resolved Hide resolved
Base automatically changed from fix/lint-fixes to main April 27, 2022 09:21
@ikurek ikurek force-pushed the fix/public-member-documentation branch from 5069727 to 35b784a Compare April 27, 2022 09:55
@github-actions github-actions bot temporarily deployed to staging/pull/381/dartdoc April 27, 2022 09:57 Inactive
KacperKluka
KacperKluka approved these changes Apr 27, 2022
View reviewed changes
Copy link

@KacperKluka KacperKluka left a comment

Choose a reason for hiding this comment

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

LGTM 👍

@ikurek ikurek force-pushed the fix/public-member-documentation branch from 1a85551 to 35b784a Compare April 27, 2022 11:09
@QuintinWillison QuintinWillison changed the title Extend public member docmentation Extend public member documentation Apr 27, 2022
@ikurek ikurek merged commit 10a94c3 into main Apr 27, 2022
@ikurek ikurek deleted the fix/public-member-documentation branch April 27, 2022 13:48
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@QuintinWillison QuintinWillison QuintinWillison approved these changes

@KacperKluka KacperKluka KacperKluka approved these changes

@lukasz-szyszkowski lukasz-szyszkowski Awaiting requested review from lukasz-szyszkowski

Assignees

@ikurek ikurek

Labels
documentation Improvements or additions to public interface documentation (API reference or readme).
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

Document public members of classes
3 participants
@ikurek @QuintinWillison @KacperKluka