Skip to content

build(aio): render param descriptions for function exports #22534

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.

Sign up for GitHub

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

Jump to bottom
Closed
petebacondarwin wants to merge 3 commits into from
Closed

build(aio): render param descriptions for function exports #22534

petebacondarwin wants to merge 3 commits into from

Conversation

@petebacondarwin
Copy link
Contributor

@petebacondarwin petebacondarwin commented Mar 1, 2018

This change aligns the rendering of exported functions with how methods in classes are rendered.
I am not actually sure if we would ever have overloads of such export functions (I couldn't find any examples in the codebase) but the logic for rendering them is in place.

Closes #22501

@petebacondarwin petebacondarwin added action: review The PR is still awaiting reviews from at least one requested reviewer comp: aio target: major This PR is targeted for the next major release labels Mar 1, 2018
petebacondarwin
petebacondarwin commented Mar 1, 2018
View reviewed changes
aio/tools/transforms/templates/api/class.template.html Outdated
Copy link
Contributor Author

@petebacondarwin petebacondarwin Mar 1, 2018

Choose a reason for hiding this comment

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

we can now move the common stuff back into the export-base

@petebacondarwin petebacondarwin force-pushed the aio-api-param-descriptions branch from dc956f8 to fc53f7a Compare March 1, 2018 20:20
@petebacondarwin petebacondarwin requested a review from gkalpak March 1, 2018 20:21
@mary-poppins
Copy link

mary-poppins commented Mar 1, 2018

You can preview fc53f7a at https://pr22534-fc53f7a.ngbuilds.io/.

@mary-poppins
Copy link

mary-poppins commented Mar 1, 2018

You can preview dc956f8 at https://pr22534-dc956f8.ngbuilds.io/.

@gkalpak
Copy link
Member

gkalpak commented Mar 2, 2018

I am not actually sure if we would ever have overloads of such export functions.

registerAsCustomElements() in the previous @angular/elements implementation had overloads (but I think it's gone in the latest implementation) 😁
So, it's possible 😃

gkalpak
gkalpak approved these changes Mar 2, 2018
View reviewed changes
aio/tools/transforms/templates/api/function.template.html Outdated
{% for overload in doc.overloads -%}
{$ memberHelpers.renderOverloadInfo(overload, 'function-overload', doc) $}
{% if not loop.last %}<hr class="hr-margin fullwidth">{% endif %}
{% endfor -%}
Copy link
Member

@gkalpak gkalpak Mar 2, 2018

Choose a reason for hiding this comment

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

Is this intentionally indented 4 spaces?

Copy link
Contributor Author

@petebacondarwin petebacondarwin Mar 2, 2018

Choose a reason for hiding this comment

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

Nope!

@gkalpak gkalpak added action: cleanup The PR is in need of cleanup, either due to needing a rebase or in response to comments from reviews and removed action: review The PR is still awaiting reviews from at least one requested reviewer labels Mar 2, 2018
@petebacondarwin petebacondarwin added action: merge The PR is ready for merge by the caretaker and removed action: cleanup The PR is in need of cleanup, either due to needing a rebase or in response to comments from reviews labels Mar 2, 2018
@mary-poppins
Copy link

mary-poppins commented Mar 2, 2018

You can preview 8f1f02d at https://pr22534-8f1f02d.ngbuilds.io/.

@alexeagle alexeagle closed this in 1d2bdcb Mar 5, 2018
alexeagle pushed a commit that referenced this pull request Mar 5, 2018
@petebacondarwin @alexeagle
build(aio): class API template once again extends export-base (#22534)
b641396 
PR Close #22534
@petebacondarwin petebacondarwin deleted the aio-api-param-descriptions branch March 7, 2018 18:45
@angular-automatic-lock-bot
Copy link

angular-automatic-lock-bot bot commented Sep 13, 2019

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 Sep 13, 2019
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.

Reviewers

1 more reviewer

@gkalpak gkalpak gkalpak approved these changes

Reviewers whose approvals may not affect merge requirements

Assignees

No one assigned

Labels

action: merge The PR is ready for merge by the caretaker cla: yes target: major This PR is targeted for the next major release

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

aio + docs/api: render @param descriptions in functions, interfaces, enums

4 participants

@petebacondarwin @mary-poppins @gkalpak @googlebot