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

Fix missing method parameter documentation #24014

Merged
merged 1 commit into from
Dec 3, 2021

Conversation

pedig
Copy link
Contributor

@pedig pedig commented Nov 25, 2021

The 'parameter.description' => 'parameter.content' change was made earlier, but as I see now there is no documentation for method parameters on material.angular.io site.
I found that the information for method parameters are stored in the 'description' field.

@pedig pedig requested a review from a team as a code owner November 25, 2021 15:36
@google-cla google-cla bot added the cla: no PR author must sign Google's Contributor License Agreement: https://opensource.google.com/docs/cla label Nov 25, 2021
@google-cla google-cla bot added cla: yes PR author has agreed to Google's Contributor License Agreement and removed cla: no PR author must sign Google's Contributor License Agreement: https://opensource.google.com/docs/cla labels Nov 25, 2021
Copy link
Member

@devversion devversion left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM. Thanks for the cleanup.

Let's see how that shows up in the docs

@devversion devversion added merge: fix commit message When the PR is merged, rewrites/fixups of the commit messages are needed action: merge The PR is ready for merge by the caretaker merge safe target: patch This PR is targeted for the next patch release labels Nov 25, 2021
Co-authored-by: Paul Gschwendtner <paulgschwendtner@gmail.com>
Fix missing method parameter documentation

The 'parameter.description' => 'parameter.content' change was made earlier, but as I see now there is no documentation for method parameters on material.angular.io site.
I found that the information for method parameters are stored in the 'description' field.
@devversion devversion removed the merge: fix commit message When the PR is merged, rewrites/fixups of the commit messages are needed label Nov 25, 2021
@wagnermaciel wagnermaciel merged commit 681f37d into angular:master Dec 3, 2021
wagnermaciel pushed a commit that referenced this pull request Dec 3, 2021
Co-authored-by: Paul Gschwendtner <paulgschwendtner@gmail.com>
Fix missing method parameter documentation

The 'parameter.description' => 'parameter.content' change was made earlier, but as I see now there is no documentation for method parameters on material.angular.io site.
I found that the information for method parameters are stored in the 'description' field.

(cherry picked from commit 681f37d)
@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 Jan 3, 2022
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 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.

3 participants