Skip to content
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

Library Linter for doc comments (and jsdoc comments) #5057

Open
markcowl opened this issue Nov 11, 2024 · 0 comments
Open

Library Linter for doc comments (and jsdoc comments) #5057

markcowl opened this issue Nov 11, 2024 · 0 comments
Labels
Milestone

Comments

@markcowl
Copy link
Contributor

Write a library linter to verify:

  • All public js APIs have explanatory comments
    • Operations
    • Operation parameters
    • Operation return types
    • interfaces
    • interface properties
    • interface methods
  • All public TSP types have explanatory comments
    • Templates
    • Template Parameters
    • Models
    • Model Properties
    • Decorators
    • Decorator Parameters
@markcowl markcowl added eng feature New feature or request mq labels Nov 11, 2024
@markcowl markcowl added this to the Backlog milestone Nov 13, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

No branches or pull requests

1 participant