Updating snippets documentation README.md #50483
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
fluttergithubbot
added
the
team
shihaohong
approved these changes
Feb 10, 2020
dev/snippets/README.md
Outdated
|
|
||
| Note that generating the sample output will not allow you to run your code in DartPad, because DartPad pulls the code it runs from the appropriate docs server (master or stable). | ||
|
|
||
| Copy your code and paste it into a regular DartPad instance to test if it runs in DartPad. You can get the code that will be produced by the interpolation of your code into a template by running the sample analysis locally (see the next section), and pasting the output file into a dartpad at https://dartpad.dartlang.org. |
There was a problem hiding this comment.
It was a little confusing to read "get the code that will be produced by the interpolation of your code into a template", so I tried to simplify it a little:
Suggested change
| Copy your code and paste it into a regular DartPad instance to test if it runs in DartPad. You can get the code that will be produced by the interpolation of your code into a template by running the sample analysis locally (see the next section), and pasting the output file into a dartpad at https://dartpad.dartlang.org. | |
| Copy the generated code and paste it into a regular DartPad instance to test if it runs in DartPad. To get the code that will be produced by your documentation changes, run sample analysis locally (see the next section) and paste the output into a DartPad at https://dartpad.dartlang.org. |
There was a problem hiding this comment.
Thanks, that's better.
|
Also, the analyzer seems to be failing on trailing whitespaces, so that has to be fixed as well |
gspencergoog
force-pushed
the
dartpad_snippets
branch
from
f30e64f
to
d64923f
Compare
|
I reflowed all the paragraphs, and formatted the lists to be more consistent in a "text" view, and removed the trailing whitespace. |
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
Updates the README file for snippets.