Skip to content

Add comments to flutter_driver for timeline class - #58823

Merged
CareF merged 5 commits into
flutter:masterfrom
CareF:flutter_driver_timeline_commets
Jun 17, 2020
Merged

Add comments to flutter_driver for timeline class#58823
CareF merged 5 commits into
flutter:masterfrom
CareF:flutter_driver_timeline_commets

Conversation

@CareF

@CareF CareF commented Jun 5, 2020

Copy link
Copy Markdown
Contributor

Description

Add comments about explanation for the json items from
timeline.dart and timeline_summary.dart.

Related Issues

None

Tests

N/A, only comments added

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.

  • I read the Contributor Guide and followed the process outlined there for submitting PRs.
  • I signed the CLA.
  • I read and followed the Flutter Style Guide, including Features we expect every widget to implement.
  • I read the Tree Hygiene wiki page, which explains my responsibilities.
  • I updated/added relevant documentation (doc comments with ///).
  • All existing and new tests are passing.
  • The analyzer (flutter analyze --flutter-repo) does not report any problems on my PR.
  • I am willing to follow-up on review comments in a timely manner.

Breaking Change

Did any tests fail when you ran them? Please read Handling breaking changes.

  • No, no existing tests failed, so this is not a breaking change.
  • Yes, this is a breaking change. If not, delete the remainder of this section.

@fluttergithubbot

fluttergithubbot commented Jun 5, 2020

Copy link
Copy Markdown
Contributor

It looks like this pull request may not have tests. Please make sure to add tests before merging. If you need an exemption to this rule, contact Hixie on the #hackers channel in Chat.

Reviewers: Read the Tree Hygiene page and make sure this patch meets those guidelines before LGTMing.

@fluttergithubbot fluttergithubbot added a: tests "flutter test", flutter_test, or one of our tests framework flutter/packages/flutter repository. See also f: labels. labels Jun 5, 2020
@CareF
Add comments to flutter_driver for timeline class
4405d2d 
Mostly about explanation for the json items from
timeline.dart and timeline_summary.dart.
goderbauer
goderbauer reviewed Jun 8, 2020
View reviewed changes
Comment thread packages/flutter_driver/lib/src/driver/timeline.dart Outdated
Comment thread packages/flutter_driver/lib/src/driver/timeline_summary.dart Outdated
Comment thread packages/flutter_driver/lib/src/driver/timeline_summary.dart Outdated
Comment thread packages/flutter_driver/lib/src/driver/timeline_summary.dart Outdated
Comment thread packages/flutter_driver/lib/src/driver/timeline_summary.dart Outdated
Comment thread packages/flutter_driver/lib/src/driver/timeline_summary.dart Outdated
@goderbauer

goderbauer commented Jun 8, 2020

Copy link
Copy Markdown
Member

/cc @yjbanov @liyuqian

liyuqian
liyuqian reviewed Jun 8, 2020
View reviewed changes

@liyuqian liyuqian left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

CC our tech writer @sfshaza2 as these documentations may eventually end up in some performance pages under https://flutter.dev. It might be nice to polish the language early on :)

Comment thread packages/flutter_driver/lib/src/driver/timeline_summary.dart Outdated
Comment thread packages/flutter_driver/lib/src/driver/timeline_summary.dart Outdated
@goderbauer

goderbauer commented Jun 17, 2020

Copy link
Copy Markdown
Member

@CareF Can you please fix the issue identified by the analyzer: https://github.com/flutter/flutter/pull/58823/checks?check_run_id=775011567

@CareF

CareF commented Jun 17, 2020

Copy link
Copy Markdown
Contributor Author

@CareF Can you please fix the issue identified by the analyzer: https://github.com/flutter/flutter/pull/58823/checks?check_run_id=775011567

Done. Sorry I shouldn't have been neglecting that. @goderbauer

liyuqian
liyuqian approved these changes Jun 17, 2020
View reviewed changes

@liyuqian liyuqian left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

LGTM

@CareF
CareF merged commit 9c3f0fa into flutter:master Jun 17, 2020
zljj0818 pushed a commit to zljj0818/flutter that referenced this pull request Jun 22, 2020
@CareF @zljj0818
Add comments to flutter_driver for timeline class (flutter#58823)
3b37203 
* Add comments to flutter_driver for timeline class

Mostly about explanation for the json items from
timeline.dart and timeline_summary.dart.
mingwandroid pushed a commit to mingwandroid/flutter that referenced this pull request Sep 6, 2020
@CareF @mingwandroid
Add comments to flutter_driver for timeline class (flutter#58823)
2bef216 
* Add comments to flutter_driver for timeline class

Mostly about explanation for the json items from
timeline.dart and timeline_summary.dart.
@github-actions github-actions Bot locked as resolved and limited conversation to collaborators Jul 30, 2021
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.

Reviewers

@filiph filiph filiph left review comments
@goderbauer goderbauer goderbauer left review comments
+1 more reviewer
@liyuqian liyuqian liyuqian approved these changes
Reviewers whose approvals may not affect merge requirements

Assignees

No one assigned

Labels

a: tests "flutter test", flutter_test, or one of our tests framework flutter/packages/flutter repository. See also f: labels.

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

6 participants

@CareF @fluttergithubbot @goderbauer @filiph @liyuqian @googlebot