Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

API documentation of FormControl is broken #56144

Open
jnizet opened this issue May 29, 2024 · 0 comments · May be fixed by #56489
Open

API documentation of FormControl is broken #56144

jnizet opened this issue May 29, 2024 · 0 comments · May be fixed by #56489
Labels
area: adev Angular.dev documentation P2 The issue is important to a large percentage of users, with a workaround
Milestone
Backlog

Comments

@jnizet
Copy link
Contributor

jnizet commented May 29, 2024

Describe the problem that you experienced

The API documentation of FormControl on angular.dev shows it as a constant instead of properly documenting the class. angular.io doesn't have this problem.

Here's the documentation we get on angular.dev:

Capture d’écran 2024-05-29 à 06 49 40

Enter the URL of the topic with the problem

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

Describe what you were looking for in the documentation

The complete documentation of the FormControl class, as it was available in the goold old angular.io: https://v17.angular.io/api/forms/FormControl

Describe the actions that led you to experience the problem

NA

Describe what you want to experience that would fix the problem

A complete documentation of the FormControl class, with its superclass, methods, properties, etc.

Add a screenshot if that helps illustrate the problem

See above

If this problem caused an exception or error, please paste it here

No response

If the problem is browser-specific, please specify the device, OS, browser, and version

No response

Provide any additional information here in as much as detail as you can

No response
@jnizet jnizet changed the title API documentation of FormCnntrol is broken API documentation of FormControl is broken May 29, 2024
@pkozlowski-opensource pkozlowski-opensource added the area: adev Angular.dev documentation label May 29, 2024
@ngbot ngbot bot added this to the needsTriage milestone May 29, 2024
@bencodezen bencodezen added the P2 The issue is important to a large percentage of users, with a workaround label Jun 3, 2024
@ngbot ngbot bot modified the milestones: needsTriage, Backlog Jun 3, 2024
@StankaKopalova StankaKopalova mentioned this issue Jun 17, 2024
Closed
JeanMeche added a commit to JeanMeche/angular that referenced this issue Jun 18, 2024
@JeanMeche
refactor(compiler-cli): Don't extract type implementations
9b55473 
This is useful for cases like class `FormControl` is defined as `interface` but the actual implementation uses a private type  `export const FormControl: ɵFormControlCtor`.

fixes angular#56144
@JeanMeche JeanMeche linked a pull request Jun 18, 2024 that will close this issue
Open
JeanMeche added a commit to JeanMeche/angular that referenced this issue Jun 18, 2024
@JeanMeche
refactor(compiler-cli): Don't extract type implementations
3f0010d 
This is useful for cases like class `FormControl` is defined as `interface` but the actual implementation uses a private type  `export const FormControl: ɵFormControlCtor`.

fixes angular#56144
JeanMeche added a commit to JeanMeche/angular that referenced this issue Jun 18, 2024
@JeanMeche
refactor(compiler-cli): Don't extract type implementations
1e32769 
This is useful for cases like class `FormControl` is defined as `interface` but the actual implementation uses a private type  `export const FormControl: ɵFormControlCtor`.

fixes angular#56144
JeanMeche added a commit to JeanMeche/angular that referenced this issue Jun 18, 2024
@JeanMeche
refactor(compiler-cli): Don't extract type implementations
e9e3c39 
This is useful for cases like class `FormControl` is defined as `interface` but the actual implementation uses a private type  `export const FormControl: ɵFormControlCtor`.

fixes angular#56144
JeanMeche added a commit to JeanMeche/angular that referenced this issue Jun 18, 2024
@JeanMeche
refactor(compiler-cli): Don't extract type implementations
d13a390 
This is useful for cases like class `FormControl` is defined as `interface` but the actual implementation uses a private type  `export const FormControl: ɵFormControlCtor`.

fixes angular#56144
JeanMeche added a commit to JeanMeche/angular that referenced this issue Jun 18, 2024
@JeanMeche
refactor(compiler-cli): Don't extract type implementations
049e797 
This is useful for cases like class `FormControl` is defined as `interface` but the actual implementation uses a private type  `export const FormControl: ɵFormControlCtor`.

fixes angular#56144
JeanMeche added a commit to JeanMeche/angular that referenced this issue Jun 19, 2024
@JeanMeche
refactor(compiler-cli): Don't extract type implementations
18bb248 
This is useful for cases like class `FormControl` is defined as `interface` but the actual implementation uses a private type  `export const FormControl: ɵFormControlCtor`.

fixes angular#56144
JeanMeche added a commit to JeanMeche/angular that referenced this issue Aug 29, 2024
@JeanMeche
refactor(compiler-cli): extract function overload separatly
8b79b70 
in order for the docs to process function entry, this commit refactor function extraction by keeping the implementation as a the default entry and adds all the overloads into a separate array of entries.

fixes angular#56144
JeanMeche added a commit to JeanMeche/angular that referenced this issue Sep 7, 2024
@JeanMeche
refactor(compiler-cli): extract function overload separatly
97f97c3 
in order for the docs to process function entry, this commit refactor function extraction by keeping the implementation as a the default entry and adds all the overloads into a separate array of entries.

fixes angular#56144
JeanMeche added a commit to JeanMeche/angular that referenced this issue Sep 7, 2024
@JeanMeche
refactor(compiler-cli): extract function overload separatly
fae1a37 
in order for the docs to process function entry, this commit refactor function extraction by keeping the implementation as a the default entry and adds all the overloads into a separate array of entries.

fixes angular#56144
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
area: adev Angular.dev documentation P2 The issue is important to a large percentage of users, with a workaround
Projects
None yet
Milestone
Backlog
3 participants
@pkozlowski-opensource @jnizet @bencodezen