This repository was archived by the owner on Nov 20, 2024. It is now read-only.
Include usage information in generated docs #4370
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
MaryaBelanger
approved these changes
May 22, 2023
There was a problem hiding this comment.
Nice! I think I'm a little confused, though. For someone to end up seeing this new "Usage" section, wouldn't it be because the lint popped up for them (so, because they already are using it)? I'm guessing there is another use case for these docs; like; are users browsing the linter docs to identify lints they might want to enable?
|
Yeah I find that many users are still using this site to find lints as well. Perhaps users will share links to lints here too. For the users with the lint already, that's why I put usage at the bottom. I'm not going to worry about moving use cases of this site to dart.dev until our improvements later on. |
copybara-service bot
pushed a commit
to dart-lang/sdk
that referenced
this pull request
Aug 23, 2023
* Include usage information in generated docs * Adjust wording
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.
Eventually moving away from the site, but since it's still used and referenced, doesn't hurt to add some usage information.
Staged example: https://parlough-linter.web.app/lints/unnecessary_late.html
Closes dart-lang/sdk#59141