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.

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

[docs] Add onTouchTap documentation for FlatButton #6147

Merged
merged 5 commits into from
Feb 17, 2017
Merged

[docs] Add onTouchTap documentation for FlatButton #6147

merged 5 commits into from
Feb 17, 2017

Conversation

Shahrukh-Zindani
Copy link

@Shahrukh-Zindani Shahrukh-Zindani commented Feb 14, 2017

  • PR has tests / docs demo, and is linted.
  • Commit and PR titles begin with [ComponentName], and are in imperative form: "[Component] Fix leaky abstraction".
  • Description explains the issue / use-case resolved, and auto-closes the related issue(s) (http://tr.im/vFqem).

Copy link
Member

@oliviertassinari oliviertassinari left a comment

Choose a reason for hiding this comment

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

Why removing the primary documentation?

@muibot muibot added PR: needs revision The pull request can't be merged. More details is available on the code review or fails in the CI and removed PR: Needs Review labels Feb 14, 2017
@Shahrukh-Zindani
Copy link
Author

My bad. Added primary documentation back.

* If true, colors button according to
* primaryTextColor from the Theme.
*/
*/
Copy link
Member

Choose a reason for hiding this comment

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

Oups

@@ -76,9 +76,14 @@ class FlatButton extends Component {
/** @ignore */
onTouchStart: PropTypes.func,
/**
* Callback function for when the element is selected via a touch tap.
Copy link
Member

@oliviertassinari oliviertassinari Feb 14, 2017

Choose a reason for hiding this comment

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

Most of the time, we follow that template:

    /**
     * Callback function fired when the button is touch-tapped.
     *
     * @param {object} event TouchTap event targeting the button.
     */
    onTouchTap: PropTypes.func,

@oliviertassinari oliviertassinari added docs Improvements or additions to the documentation and removed PR: Needs Review labels Feb 14, 2017
@oliviertassinari oliviertassinari changed the title [Docs] Add onTouchTap documentation for FlatButton. [docs] Add onTouchTap documentation for FlatButton Feb 14, 2017
* Callback function fired when the button is touch-tapped.
*
* @param {object} event TouchTap event targeting the button.
*/
Copy link
Member

Choose a reason for hiding this comment

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

Same wrong indentation.

@oliviertassinari oliviertassinari added PR: Review Accepted and removed PR: Needs Review PR: needs revision The pull request can't be merged. More details is available on the code review or fails in the CI labels Feb 17, 2017
@oliviertassinari oliviertassinari merged commit f9d263a into mui:master Feb 17, 2017
@oliviertassinari
Copy link
Member

Thanks.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs Improvements or additions to the documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants