Skip to content

Warn on common directive typos #1814

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
jcollins-g opened this issue Oct 31, 2018 · 1 comment
Open

Warn on common directive typos #1814

jcollins-g opened this issue Oct 31, 2018 · 1 comment
Labels
customer-flutter Issues originating from important to Flutter P3 A lower priority bug or feature request type-enhancement A request for a change that isn't a bug

Comments

@jcollins-g
Copy link
Contributor

Sometimes people don't get the case right for dartdoc directives or otherwise make minor errors. We could give more help to the user to make it clear what's going wrong.

@jcollins-g jcollins-g added type-enhancement A request for a change that isn't a bug P3 A lower priority bug or feature request customer-flutter Issues originating from important to Flutter labels Oct 31, 2018
@srawlins
Copy link
Member

srawlins commented Sep 7, 2020

We could issue warnings for the following:

  • any unknown directive name /\{@[a-z].*\}
  • wrong case for name ({@YouTube}, @{inject-HTML})
  • wrong punctuation for name (@{injecthtml}, @{end-template})
  • directive with no trailing }, which may span multiple lines
  • @example with src foo.dart.md when foo.dart.md.md doesn't exist; @example with src foo.dart when foo.dart.md doesn't exist, but foo.dart does.
  • {@tool} with no {@end-tool}, etc.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
customer-flutter Issues originating from important to Flutter P3 A lower priority bug or feature request type-enhancement A request for a change that isn't a bug
Projects
None yet
Development

No branches or pull requests

2 participants