Skip to content

it would be nice to have a way to automatically show methods and properties that are deprecated #30408

Closed
@jenniferfell

Description

@jenniferfell

📚 Docs or angular.io bug report

Description

Currently, if a property or method is deprecated, a code owner or doc author must explicitly state that in the description text for that property or method. There is no automated way to have these presented in the AIO docs with strikethrough and a standard "Deprecated in version x" statement.

🔬 Minimal Reproduction

See https://next.angular.io/api/forms/ReactiveFormsModule#withconfig

There is no indication in the AIO docs that this is deprecated.

Now click < > to see the source code, where the deprecation is mentioned:

static withConfig(opts: {
    /** @deprecated as of v6 */ warnOnNgModelWithFormControl: 'never' | 'once' | 'always'
  }): ModuleWithProviders<ReactiveFormsModule> {
    return {
      ngModule: ReactiveFormsModule,
      providers: [{
        provide: NG_MODEL_WITH_FORM_CONTROL_WARNING,
        useValue: opts.warnOnNgModelWithFormControl
      }]
    };

What's the affected URL?**

See above. Also see #30098 for more examples.

Reproduction Steps**

See above

Expected vs Actual Behavior**

Readers expect AIO to clearly identify these properties and methods as deprecated, without having to open the source code to read the comments.

📷Screenshot

🔥 Exception or Error





🌍 Your Environment

Browser info

Anything else relevant?

Related Issues:
Deprecate ReactiveFormsModule.withConfig method
#22640

docs: add deprecation info for properties, methods, etc. to deprecations summary doc
#30098

Metadata

Metadata

Assignees

No one assigned

    Labels

    P5The team acknowledges the request but does not plan to address it, it remains open for discussion

    Type

    No type

    Projects

    No projects

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions