Skip to content

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

Merged
merged 1 commit into from
May 28, 2021

Conversation

jelbourn
Copy link
Member

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.

@jelbourn jelbourn added target: patch This PR is targeted for the next patch release area: theming labels May 26, 2021
@jelbourn jelbourn requested review from crisbeto and mmalerba May 26, 2021 20:27
@jelbourn jelbourn requested a review from devversion as a code owner May 26, 2021 20:27
@google-cla google-cla bot added the cla: yes PR author has agreed to Google's Contributor License Agreement label May 26, 2021
Copy link
Member

@crisbeto crisbeto left a 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.
@jelbourn jelbourn added the action: merge The PR is ready for merge by the caretaker label May 27, 2021
Copy link
Member Author

@jelbourn jelbourn left a 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

@mmalerba mmalerba merged commit 4f75c27 into angular:master May 28, 2021
mmalerba pushed a commit that referenced this pull request May 28, 2021
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)
@angular-automatic-lock-bot
Copy link

This issue has been automatically locked due to inactivity.
Please file a new issue if you are encountering a similar or related problem.

Read more about our automatic conversation locking policy.

This action has been performed automatically by a bot.

@angular-automatic-lock-bot angular-automatic-lock-bot bot locked and limited conversation to collaborators Jun 28, 2021
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
action: merge The PR is ready for merge by the caretaker area: theming cla: yes PR author has agreed to Google's Contributor License Agreement target: patch This PR is targeted for the next patch release
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants