Tweak docs. #3346
Merged
Tweak docs. #3346
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
rodrigogiraoserrao
requested review from
davep,
willmcgugan and
darrenburns
willmcgugan
approved these changes
Sep 19, 2023
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.
I added all headers about reactives, messages, bindings, and component classes for all widgets, even if the widget doesn't have them.
Some widgets already had it and I noticed I was quicker to find the header in the ToC and then read “this widget doesn't have bindings” than to go over the ToC three times, only to deduce the widget didn't have any bindings because the header wasn't there.
This is also more foolproof than omitting headers that are not relevant because omitting an irrelevant header or forgetting a header look the same.