microsoft / microsoft/typespec

Library Linter for doc comments (and jsdoc comments)

Open
#5,057 0 comments 0 reactions 0 assignees View on GitHub
eng feature mq triaged:core
Dominant language
Java
Stars
5.9k
Forks
394
Avg merge
1d 23h
Merged PRs (30d)
104

Description

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

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.