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

Add sample code to Icons Class #31725

Closed
wants to merge 1 commit into from

Conversation

castrors
Copy link

@castrors castrors commented Apr 27, 2019

Description

Add sample code to Material Icons class

Related Issues

Related to #21136

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 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. labels Apr 28, 2019
Copy link
Contributor

@shihaohong shihaohong left a comment

Choose a reason for hiding this comment

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

Thank you for adding sample docs! Please see my suggestions for your PR and let me know if you have any questions.

@@ -34,10 +55,12 @@ class Icons {
// BEGIN GENERATED

/// <i class="material-icons md-36">360</i> &#x2014; material icon named "360".
static const IconData threesixty = IconData(0xe577, fontFamily: 'MaterialIcons');
static const IconData threesixty =
Copy link
Contributor

Choose a reason for hiding this comment

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

You should revert all of these changes back to one-liners, since they're not related to your current PR

@@ -21,6 +21,27 @@ import 'package:flutter/widgets.dart';
/// uses-material-design: true
/// ```
///
/// {@tool snippet --template=stateless_widget_scaffold}
///
/// This example shows how to use [Icons] to create three icons: fast rewind,
Copy link
Contributor

Choose a reason for hiding this comment

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

This example creates three [Icons], fast_rewind, play_arrow and fast_forward, in that order.

@@ -21,6 +21,27 @@ import 'package:flutter/widgets.dart';
/// uses-material-design: true
/// ```
///
/// {@tool snippet --template=stateless_widget_scaffold}
Copy link
Contributor

Choose a reason for hiding this comment

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

[Nice-to-have] Adding a sample output image like ListTile docs. See https://github.com/flutter/assets-for-api-docs for example pull requests.

Let me know if you have any questions about how to get this set up!

@castrors castrors closed this Apr 29, 2019
@castrors castrors deleted the doc/icons_class branch April 29, 2019 17:45
@github-actions github-actions bot locked as resolved and limited conversation to collaborators Aug 6, 2021
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
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
Development

Successfully merging this pull request may close these issues.

None yet

3 participants