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

build: show deletion target in docs #9648

Merged
merged 1 commit into from
Jan 31, 2018

Conversation

devversion
Copy link
Member

  • Surfaces the @deletion-target JSDoc information into the Dgeni HTML output. Currently it will add a title to the deprecation marker.

Closes #9641

* Surfaces the @deletion-target JSDoc information into the Dgeni HTML output. Currently it will add a title to the deprecation marker.

Closes angular#9641
@googlebot googlebot added the cla: yes PR author has agreed to Google's Contributor License Agreement label Jan 28, 2018
Copy link
Member

@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.

LGTM

@@ -19,7 +21,9 @@
</div>
{%- endif -%}
{%- if property.isDeprecated -%}
<div class="docs-api-deprecated-marker">Deprecated</div>
<div class="docs-api-deprecated-marker" {$ macros.deprecationTitle(property) $}>
Copy link
Member

Choose a reason for hiding this comment

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

It would also be cool to add a dotted underline to the deprecation marker to indicate that there's a hover effect. We could do this in a follow-up PR on the docs site w/ something like

.docs-api-deprecated-marker[title] {
  border-bottom: 1px dotted gray;
}

@jelbourn jelbourn added pr: lgtm action: merge The PR is ready for merge by the caretaker and removed pr: needs review labels Jan 30, 2018
@tinayuangao tinayuangao merged commit 664d69e into angular:master Jan 31, 2018
@devversion devversion deleted the docs/show-deletion-target branch February 1, 2018 15:15
devversion added a commit to devversion/material.angular.io that referenced this pull request Feb 6, 2018
* Adds a dotted underline to the `Deprecated` markers. Those can be hovered to see more information about the deprecation / deletion.
* Fixes that the deprecation markers are too big and are not looking good in the API table
* Adds a line through property names that are also deprecated. This makes it clear that this API is deprecated and also looks pretty good.

References angular/components#9648
devversion added a commit to devversion/material.angular.io that referenced this pull request Feb 6, 2018
* Adds a dotted underline to the `Deprecated` markers. Those can be hovered to see more information about the deprecation / deletion.
* Fixes that the deprecation markers are too big and are not looking good in the API table
* Adds a line through property names that are also deprecated. This makes it clear that this API is deprecated and also looks pretty good.

References angular/components#9648
jelbourn pushed a commit to angular/material.angular.io that referenced this pull request Feb 9, 2018
* Adds a dotted underline to the `Deprecated` markers. Those can be hovered to see more information about the deprecation / deletion.
* Fixes that the deprecation markers are too big and are not looking good in the API table
* Adds a line through property names that are also deprecated. This makes it clear that this API is deprecated and also looks pretty good.

References angular/components#9648
@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 Sep 8, 2019
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
Projects
None yet
Development

Successfully merging this pull request may close these issues.

dgeni: use @deletion-target jsdoc info in the docs
4 participants