Style: Link method argument definitions#721
Merged
fdwr merged 5 commits intowebmachinelearning:mainfrom Jul 12, 2024
inexorabletash:style-arg-dfns
Merged
Style: Link method argument definitions#721fdwr merged 5 commits intowebmachinelearning:mainfrom inexorabletash:style-arg-dfns
fdwr merged 5 commits intowebmachinelearning:mainfrom
inexorabletash:style-arg-dfns
Conversation
Also adds a lint rule to enforce that every argument given in IDL is linked to a prose definition for it, and a lint rule to look for argument definitions that don't match their methods. Fixes #574
Contributor
Author
|
I've had this change locally for a while, but just stumbled on how to craft the Bikeshed linking syntax to make it comprehensive and possible to lint. Happy to drop this to draft, but it seems easy/worth merging. |
inexorabletash
commented
Jul 11, 2024
github-actions bot
added a commit
that referenced
this pull request
Jul 12, 2024
SHA: dbb9d1c Reason: push, by fdwr Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
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.
Also adds a lint rule to enforce that every argument given in IDL is linked to a prose definition for it, and a lint rule to look for argument definitions that don't match their methods.
Fixes #574
Preview | Diff