fix typo by johnpryan · Pull Request #4938 · flutter/website

johnpryan · 2020-10-30T18:14:08Z

No description provided.

sfshaza2

A few minor comments but, otherwise, lgtm

sfshaza2 · 2020-10-30T18:15:47Z

+
+Flutter is an open source project hosted [on
+GitHub](https://github.com/flutter/flutter), and making the documentation better
+helps everyone! So for the month of November, we’re extending a special


sfshaza2 · 2020-10-30T18:20:02Z

+
+**Respond within three days after being assigned**
+
+If we don't hear back from you, we might need to assign someone else.


=> assign it to someone else.

sfshaza2 · 2020-10-30T18:20:24Z

+
+**One issue at a time**
+
+If you're already working on an issue, wait until it's closed before asking for


asking for => requesting

sfshaza2 · 2020-10-30T18:23:02Z

+*   The behavior of the widget in certain situations
+*   Other important information about the widget
+
+See the [Documentation section](https://github.com/flutter/flutter/wiki/Style-guide-for-Flutter-repo#documentation-dartdocs-javadocs-etc) of the Flutter Style Guide and [Effective Dart: Documentation](https://dart.dev/guides/language/effective-dart/documentation) for details on how to write great documentation.


Can you break this up? We use break at 80 chars or less.

sfshaza2 · 2020-10-30T18:23:40Z

+To get started, fork the SDK and use Git to fetch a local copy:
+
+1. Install dependencies listed in [Setting up the Framework development environment](https://github.com/flutter/flutter/wiki/Setting-up-the-Framework-development-environment)
+2. Fork the flutter repo [https://github.com/flutter/flutter](https://github.com/flutter/flutter). For more information, see [GitHub's official instructions](https://docs.github.com/en/free-pro-team@latest/github/getting-started-with-github/fork-a-repo).


Break this up, too.

sfshaza2 · 2020-10-30T18:24:13Z

+3. Clone your fork: `git clone https://github.com/&lt;your_name_here>/flutter.git`
+4. Change directory: `cd flutter`
+5. Add an upstream remote: `git remote add upstream git@github.com:flutter/flutter.git`
+6. Run `flutter update-packages` to fetch all the Dart packages Flutter uses.


=> packages that Flutter uses

sfshaza2 · 2020-10-30T18:24:53Z

+
+### Analyzing and Generating API Docs
+
+Running this command from the root directory will analyze and generate the


=> analyzes and generates (and delete "will")

sfshaza2 · 2020-10-30T18:26:13Z

+git checkout -b update-builder-widget
+git add -A
+git commit -m "Update Builder API Docs"
+git push origin update-builder-widget


Wow, you do this very differently than I do. I use vim.

I use vim too, but the -m flag is simpler to create instructions for.

sfshaza2

A couple minor HTML issues but LGTM otherwise.

sfshaza2 · 2020-10-30T19:17:16Z

+
+3. Once you are assigned, set up your environment, make the change, and submit
+the pull request. If you're not sure how to do this, see the
+[Quickstart](#quickstart) below.


Notice how the generated list goes: 1, 2, 1.

This is because you inserted an image on item #2. To get around this, I drop into HTML. So, it would look like:

Go to...

Leave a comment...

Once you are assigned...

sfshaza2 · 2020-10-30T19:17:37Z

+the pull request. If you're not sure how to do this, see the
+[Quickstart](#quickstart) below.
+
+The [CONTRIBUTING](https://github.com/flutter/flutter/blob/master/CONTRIBUTING.md) doc has details on contributing to Flutter.


Break up this line, too. :)

sfshaza2 · 2020-10-30T19:20:20Z

+**Note:** Flutter API docs cannot be generated on Windows. If you are using
+*Windows, you may need to download the Linux version of the SDK and use the
+*[Windows Subsystem for
+*Linux](https://docs.microsoft.com/en-us/windows/wsl/about).


This is rendering weirdly. It appears that you are trying to create a code-style note, but it doesn't work as you think it does in markdown.

Instead:

{{site.alert.note}} Flutter API docs cannot be generated on Windows. If you are using Windows, you may need to download the Linux version of the SDK and use the [Windows Subsystem for Linux](https://docs.microsoft.com/en-us/windows/wsl/about). {{site.alert.end}}

You know, we don't actually do our links inline like this, but this is a temporary page, so I'm going to ignore that. :)

* fix typo * fix code review comments * fix number formatting * fix formatting issues * use site.alert.note * fix <aside> appearing in note * update Discord link

fix typo

2131640

johnpryan requested a review from sfshaza2 October 30, 2020 18:14

google-cla bot added the cla: yes Contributor has signed the Contributor License Agreement label Oct 30, 2020

sfshaza2 reviewed Oct 30, 2020

View reviewed changes

johnpryan added 2 commits October 30, 2020 12:06

fix code review comments

3601880

fix number formatting

fb3e4cf

sfshaza2 approved these changes Oct 30, 2020

View reviewed changes

johnpryan added 4 commits October 30, 2020 12:24

fix formatting issues

e33b71b

use site.alert.note

15cbe8e

fix <aside> appearing in note

35ccb92

update Discord link

05543ab

johnpryan merged commit 6649682 into flutter:master Oct 30, 2020

filiph pushed a commit to filiph/website that referenced this pull request Feb 22, 2021

fix typo (flutter#4938)

9ef0e71

* fix typo * fix code review comments * fix number formatting * fix formatting issues * use site.alert.note * fix <aside> appearing in note * update Discord link


		Respond within three days after being assigned

		If we don't hear back from you, we might need to assign someone else.


		One issue at a time

		If you're already working on an issue, wait until it's closed before asking for


		### Analyzing and Generating API Docs

		Running this command from the root directory will analyze and generate the

Conversation

johnpryan commented Oct 30, 2020

Uh oh!

sfshaza2 left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

sfshaza2 left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

sfshaza2 Oct 30, 2020 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

sfshaza2 Oct 30, 2020 •

edited

Loading