docs: add deprecation info for properties, methods, etc.
See original GitHub issueπ 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 https://github.com/angular/angular/pull/26733#discussion_r278041763
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?
Issue Analytics
- State:
- Created 4 years ago
- Comments:5 (4 by maintainers)
Top Results From Across the Web
Deprecated and obsolete features - JavaScript - MDN Web Docs
The compile() method is deprecated. Construct a new RegExp instance instead. Function. The caller property of functions and the arguments.
Read more >How and When to Deprecate APIs
NOTE: Deprecation applies to classes and to individual methods or properties, not to their names. It is possible for a single method to...
Read more >How to deprecate PHP's magic property in PHPDoc?
@Isaac, the accepted answer involves creating an (otherwise unused) trait and including it in the main class' PHPDoc. While my answer is allΒ ......
Read more >Deprecations by version - GitLab Docs
Deprecations by version. In each release, GitLab announces features that are deprecated and no longer recommended for use. Each deprecated feature will beΒ ......
Read more >Deprecations | Android Enterprise
This page lists all the managed Google Play features which are currently in a deprecation period. This includes features and methods under the...
Read more >
Top Related Medium Post
No results found
Top Related StackOverflow Question
No results found
Troubleshoot Live Code
Lightrun enables developers to add logs, metrics and snapshots to live code - no restarts or redeploys required.
Start Free
Top Related Reddit Thread
No results found
Top Related Hackernoon Post
No results found
Top Related Tweet
No results found
Top Related Dev.to Post
No results found
Top Related Hashnode Post
No results found
@gkalpak I resolved it in #34088
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.