Skip to content

Validate that docstrings don't contain extraneous things #2090

Description

@tjprescott
/**
 * Does some foo.
 * @param blah Doesn't exist
 * /
 extern dec doSomeFoo(entity: TypeSpec.Reflection.Operation);

Clearly, blah doesn't exist. We have validation that would complain if blah did exist and we document it, but should we also complain if a documented thing doesn't exist? The idea is that these things come about via copy-paste errors (or now, could be CoPilot X errors!) and so this would be a clue that perhaps you didn't do what you intended.

Metadata

Metadata

Assignees

No one assigned

    Labels

    docsImprovements or additions to documentationeng

    Type

    No type

    Projects

    No projects

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions