Skip to content

docs: add deprecation info for properties, methods, etc. #30098

Closed

Description

@jenniferfell

📚 Docs or angular.io bug report

Description

Currently, we mark exports as deprecated in the API reference docs and mention them in the Deprecation Summary.

We do not mention properties, methods, etc. consistently in the Deprecation Summary. They are, however, marked @deprecated in the source code. When they are marked in code, they do not appear in the API reference.

@trotyl makes the reasonable recommendation that we do more to highlight these deprecations as well. See #26733 (comment)

A clear and concise description of the problem...

🔬 Minimal Reproduction

Some examples:

WrappedValue#wrapped (code) --example of omitting from API ref
IterableDiffers#factories (code)
KeyValueDiffers#factories (code)
one of Injector#get() overload (code)
one of Injector.create() overload (code) -- example of text saying deprecated in API ref
ViewContainerRef#parentInjector (code)
Testability#increasePendingRequestCount (code)
Testability#decreasePendingRequestCount (code)

Same for other packages, can be found by searching @deprecated in source code.

What's the affected URL?**

https://angular.io/...

https://angular.io/api
https://angular.io/api/*
https://next.angular.io/guide/deprecation (soon to be https://angular.io/guide/deprecations)

Reproduction Steps**

See above

Expected vs Actual Behavior**

See above

📷Screenshot

🔥 Exception or Error





🌍 Your Environment

Browser info

Anything else relevant?

Activity

  1. added this to the needsTriage milestone on Apr 25, 2019
  2. modified the milestones: needsTriage, Backlog on May 16, 2019
  3. ajitsinghkaler commented on Apr 19, 2020

    @ajitsinghkaler
    Contributor

    @gkalpak @kapunahelewong I think we can close this I resolved the issue

  4. gkalpak commented on Apr 20, 2020

    @gkalpak
    Member

    @ajitsinghkaler, can you please add more info on how/where this issue was resolved?

  5. ajitsinghkaler commented on Apr 21, 2020

    @ajitsinghkaler
    Contributor

    @gkalpak I resolved it in #34088

  6. ajitsinghkaler commented on Apr 21, 2020

    @ajitsinghkaler
    Contributor

    @gkalpak I resolved it in #34088

  7. angular-automatic-lock-bot commented on May 22, 2020

    @angular-automatic-lock-bot

    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.

  8. locked and limited conversation to collaborators on May 22, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Labels

featureLabel used to distinguish feature request from other issuesfreq2: medium

Type

No type

Projects

No projects

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions