Initiate API ideation #9
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
* My pass at answering some questions - Some wording tweaks - Added closebutton="" attribute - Made attributes and properties generally more detailed - Explained how showToast() connects to std-toast in more detail - Added "actionclick" event (although it's still not super well fleshed out) - Explained content model - Removed duplicate toasts pattern; that shouldn't be common - Added more TODOs for harder problems * Update README.md * Respond to review comments
* Fill out "Why?" section more * Update README.md
fergald
reviewed
May 24, 2019
Co-Authored-By: fergald <fergald@gmail.com>
domenic
reviewed
May 24, 2019
ojanvafai
reviewed
May 24, 2019
fergald
reviewed
May 29, 2019
There was a problem hiding this comment.
Please leave TODOs in the doc with a short summary and a link to the issue. E.g.
TODO(#13): decide on how we position the toastI think GH will auto-link the #13 in there.
Basically think of this as google doc + comments but a bit more manual. Readers should be able to see that there is an outstanding discussion on a point and in general when you resolve an issue it should be reflected by deleting the TODO and updating the doc. There tend to be 2 types of comment on design docs
- A valid point about something missing from the doc, e.g. raising a reasonable alternative, this should be resolved by choosing which to use and documenting that we considered another approach and reasons why we prefer the chosen one
- An invalid point about the doc, e.g. caused by a misunderstanding or whatever. In many cases this indicates that your doc needs to be clearer in some way. Resolve it by improving the doc such that the same misunderstanding is harder to make.
If the issue comes up in PR, maybe you can address it there and then (especially for an invalid point) but in the interests of not blocking PRs, punt things out to TODO(#nnn).
domenic
approved these changes
May 29, 2019
Co-Authored-By: Domenic Denicola <d@domenic.me>
Co-Authored-By: Domenic Denicola <d@domenic.me>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
No description provided.