Skip to content

Clarify showDuration and waitDuration API docs and test behavior #36970

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
Merged
shihaohong merged 2 commits into from
Jul 26, 2019
Merged

Clarify showDuration and waitDuration API docs and test behavior #36970

shihaohong merged 2 commits into from
Jul 26, 2019

Conversation

@shihaohong
Copy link
Contributor

@shihaohong shihaohong commented Jul 25, 2019

Description

Add some clarification to the API doc and the tests for Tooltip.showDuration and Tooltip.waitDuration.

Related Issues

Fixes #36032

Tests

I added the following tests:

n/a, update test behavior.

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 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

Does your PR require Flutter developers to manually update their apps to accommodate your change?

  • Yes, this is a breaking change (Please read Handling breaking changes). Replace this with a link to the e-mail where you asked for input on this proposed change.
  • No, this is not a breaking change.

@shihaohong shihaohong added framework flutter/packages/flutter repository. See also f: labels. f: material design flutter/packages/flutter/material repository. d: api docs Issues with https://api.flutter.dev/ labels Jul 25, 2019
gspencergoog
gspencergoog approved these changes Jul 25, 2019
View reviewed changes
Copy link
Contributor

@gspencergoog gspencergoog left a comment •
edited
Loading

Choose a reason for hiding this comment

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

This looks good, but it's not just a docs change (it changes the test too): you might update the PR title.

32384589-a60f0e74-c078-11e7-9bc1-e5b5287aea9d

@shihaohong shihaohong changed the title Clarify showDuration and waitDuration API docs Clarify showDuration and waitDuration API docs and test behavior Jul 26, 2019
@shihaohong shihaohong merged commit f1e87c4 into flutter:master Jul 26, 2019
johnsonmh pushed a commit to johnsonmh/flutter that referenced this pull request Jul 30, 2019
@johnsonmh
Clarify showDuration and waitDuration API docs and test behavior (flu…
8c59796 
…tter#36970)

* Improve showDuration and waitDuration explanation and tests

* Add condition to test to ensure that tooltip does not show before long press duration is over
@shihaohong shihaohong deleted the tooltip-docs branch September 10, 2019 16:20
@github-actions github-actions bot locked as resolved and limited conversation to collaborators Aug 4, 2021
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.

Reviewers

@gspencergoog gspencergoog gspencergoog approved these changes

@HansMuller HansMuller Awaiting requested review from HansMuller

Assignees

No one assigned

Labels

d: api docs Issues with https://api.flutter.dev/ f: material design flutter/packages/flutter/material repository. 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.

Tooltip waitDuration and showDuration properties can be elaborated on

3 participants

@shihaohong @gspencergoog @googlebot