Skip to content
This repository was archived by the owner on Dec 4, 2017. It is now read-only.

dgeni: @deprecated tag has no visible output in API docs #1097

Closed
naomiblack opened this issue Apr 16, 2016 · 4 comments
Closed

dgeni: @deprecated tag has no visible output in API docs #1097

naomiblack opened this issue Apr 16, 2016 · 4 comments
Assignees

Comments

@naomiblack
Copy link
Contributor

See https://angular.io/docs/ts/latest/api/common/FORM_BINDINGS-let.html for an example of a live page that should have an @deprecated warning, per https://github.com/angular/angular/blob/2.0.0-beta.15/modules/angular2/src/common/forms.ts#L64-L64

@ericjim @IgorMinar @petebacondarwin

@ericjim
Copy link
Member

ericjim commented Apr 18, 2016

I'll do this one next, I'll refer to the API doc proposal from here #964

@ericjim
Copy link
Member

ericjim commented Apr 19, 2016

Work in-progress, but getting there.

screenshot 2016-04-18 21 43 18

screenshot 2016-04-18 21 43 02

screenshot 2016-04-18 21 42 44

@ericjim
Copy link
Member

ericjim commented Apr 19, 2016

@naomiblack as it stands, I am defaulting to stable.

I can perform a check for @stable, however, if we choose to default to experimental every single page in the api doc will have an experimental label, unless given that the explicit @stable which currently does not exist in angular.io or angular2. I can add the tag in angular.io, but we will need to coordinate the @stable effort on angular2. Is this what we want?

References:
#1098

Preview:
screenshot 2016-04-18 22 02 47

@naomiblack
Copy link
Contributor Author

on further reflection, I think we need to have four states: stable / experimental / deprecated / undefined.

Could you create both @stable and @experimental and then make the default (undefined) show no button at all? that gives us space to go through the API surface incrementally, and saves us from accidentally making something experimental look "done".

@IgorMinar FYI

Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Projects
None yet
Development

No branches or pull requests

2 participants