Dartdoc Generation README Improvements #34073
Merged
Conversation
This file contains hidden or 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
shihaohong
added
framework
Piinks
reviewed
Jun 7, 2019
There was a problem hiding this comment.
This is great! 🎉
You can choose to ignore most of these nits if you like.
As I was reading through, I got lost a few times around code blocks, examples, samples, snippets - samples of samples kind of thing.. 😜
I tried to make them more uniform in the suggestions below. Here's how I appraoched formatting them:
- block = finished product that is seen in the API documentation
- example = an example of one of the tools in use
snippets= the toolsample= the tool- sample = the literal/copiable code within the finished block
Let me know what you think!
|
Those suggestions are great! Honestly, I was getting lost in my head too with the mix-and-match of samples, snippets, examples, and blocks. |
Piinks
approved these changes
Jun 10, 2019
|
Addresses #31628 as well |
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
preambleandimportsThe image links seem broken because they are relative links. See https://github.com/shihaohong/flutter/tree/dartdocs/dev/snippets for how they would actually turn out.
Related Issues
Fixes #32725