Skip to content

Improve MacOsDeviceInfo documentation #192

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

Merged
merged 3 commits into from
Apr 10, 2021

Conversation

ueman
Copy link
Contributor

@ueman ueman commented Apr 4, 2021

Description

This PR improves the documentation of the MacOsDeviceInfo class.
It fixes some typos and formatting incompatibilities with Dart's documentation generator.

See https://pub.dev/documentation/device_info_plus_platform_interface/1.0.0/model_macos_device_info/MacOsDeviceInfo-class.html for how it currently looks like.

Related Issues

None as far as I am aware.

Checklist

Before you create this PR confirm that it meets all requirements listed below by checking the relevant checkboxes ([x]).
This will ensure a smooth and quick review process. Updating the pubspec.yaml and changelogs is not required.

  • I read the Contributor Guide and followed the process outlined there for submitting PRs.
  • My PR includes unit or integration tests for all changed/updated/fixed behaviors (See Contributor Guide).
  • All existing and new tests are passing.
  • I updated/added relevant documentation (doc comments with ///).
  • The analyzer (flutter analyze) does not report any problems on my PR.
  • I read and followed the Flutter Style Guide.
  • I am willing to follow-up on review comments in a timely manner.

Breaking Change

Does your PR require plugin users to manually update their apps to accommodate your change?

  • Yes, this is a breaking change (please indicate a breaking change in CHANGELOG.md and increment major revision).
  • No, this is not a breaking change.

@ueman
Copy link
Contributor Author

ueman commented Apr 4, 2021

It seems like the formatting step didn't complete. I'm not sure why though. Please let me know if I need to change anything in that regard.

Copy link
Member

@mhadaily mhadaily left a comment

Choose a reason for hiding this comment

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

LGTM, Thanks @ueman, I have triggered rebuild again, let's see.

@ueman
Copy link
Contributor Author

ueman commented Apr 6, 2021

It fails because it runs into a timeout: https://github.com/fluttercommunity/plus_plugins/blob/main/.github/workflows/all_plugins.yaml#L35-L55 @mhadaily

@miquelbeltran
Copy link
Member

Timeout increase did the trick!

@miquelbeltran miquelbeltran merged commit 7e8ba79 into fluttercommunity:main Apr 10, 2021
@ueman ueman deleted the patch-1 branch May 6, 2021 06:16
@github-actions github-actions bot locked as resolved and limited conversation to collaborators Feb 7, 2025
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants