-
Notifications
You must be signed in to change notification settings - Fork 6.8k
docs(material/theming): add SassDoc for public theming APIs #22819
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
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM, aside from the issues flagged by Miles.
This adds "correct" SassDoc for the core theming APIs, including parameters and return values with types. It doesn't look like either WebStorm or VS Code actually _support_ SassDoc, but this at least makes our source a bit more documented.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Comments addressed- good catch on the //
, WebStorm doesn't handle triple-slash with the combine-lines shortcut
This adds "correct" SassDoc for the core theming APIs, including parameters and return values with types. It doesn't look like either WebStorm or VS Code actually _support_ SassDoc, but this at least makes our source a bit more documented. (cherry picked from commit 4f75c27)
This issue has been automatically locked due to inactivity. Read more about our automatic conversation locking policy. This action has been performed automatically by a bot. |
This adds "correct" SassDoc for the core theming APIs, including
parameters and return values with types.
It doesn't look like either WebStorm or VS Code actually support
SassDoc, but this at least makes our source a bit more documented.