Stuck on an issue?

Lightrun Answers was designed to reduce the constant googling that comes with debugging 3rd party libraries. It collects links to all the places you might be looking at while hunting down a tough bug.

And, if you’re still stuck at the end, we’re happy to hop on a call to see how we can help out.

Overridden internal methods show up in API docs

See original GitHub issue

Description

Currently, overridden internal methods of classes show up in the API docs. For example, see the FormControl page. Methods that start with underscore (such as _updateValue) are marked as @internal (example), so they should not appear in API docs. However, @internal methods that do not have the override keyword are not present on the page (for example this one), so I guess the problem is isolated to the inherited @internal methods.

What is the affected URL?

https://angular.io/api/forms/FormControl

Issue Analytics

State:
Created 2 years ago
Comments:5 (4 by maintainers)

Top GitHub Comments

1reaction

devversioncommented, Dec 27, 2021

FYI @gkalpak, in the components repo we already use a Yarn resolution to update the underlying TS version, so from the COMP side, an update would be appreciated and is low-risk on that side.

1reaction

gkalpakcommented, Dec 23, 2021

Here is a fix for dgeni-packages: angular/dgeni-packages#318 You can see how that PR would affect the generated angular.io docs here: angular/dgeni-packages@16c63e6fc1febb7a8688a63be88209f23948ad79

Top Results From Across the Web

Python class decorator that overrides internal method

So to override a parent-class method, you simply provide a definition of the desired class attribute. Methods are just class attributes with ...

`override-with-generic-response` not working from `1.6.8 ...

Describe the bug When using the springdoc.override-with-generic-response=true property after version 1.6.7 methods annotated with ...

Configure API docs functionality - Redocly

In this case, specify the options in the features.openapi section. Note that live configuration in Workflows may be used to override the Redocly ......

Use a mapping template to override an API's request and ...

In this tutorial, you'll override the GET method's request header code by creating a mapping template that maps $context. requestOverride.

Swagger RESTful API Documentation Specification

These files can then be used by the Swagger-UI project to display the API and ... It is up to the specification user...