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

Not all API documentation is visible #55196

Closed
atscott opened this issue Apr 3, 2024 · 2 comments
Closed

Not all API documentation is visible #55196

atscott opened this issue Apr 3, 2024 · 2 comments
Assignees
@JeanMeche
Labels
area: adev Angular.dev documentation P3 An issue that is relevant to core functions, but does not impede progress. Important, but not urgent
Milestone
Backlog

Comments

@atscott
Copy link
Contributor

atscott commented Apr 3, 2024

Which @angular/* package(s) are the source of the bug?

Don't known / other

Is this a regression?

Yes

Description

The information in JSDoc tags is not available in the API reference page. It appears that only the main documentation is presented.

image The APIs are deprecated but the description of why is not visible image image `navigateByUrl` is missing the `@usageNotes` information image

Please provide a link to a minimal reproduction of the bug

No response

Please provide the exception or error you saw

No response

Please provide the environment you discovered this bug in (run ng version)

No response

Anything else?

No response
@atscott atscott added the area: adev Angular.dev documentation label Apr 3, 2024
@ngbot ngbot bot added this to the needsTriage milestone Apr 3, 2024
@JeanMeche JeanMeche self-assigned this Apr 3, 2024
JeanMeche added a commit to JeanMeche/dev-infra that referenced this issue Apr 3, 2024
@JeanMeche
refactor(api-gen): add deprecation message and usage notes in class m…
ddedf89 
…embers

As reported by angular/angular#55196
@JeanMeche JeanMeche mentioned this issue Apr 3, 2024
Closed
JeanMeche added a commit to JeanMeche/dev-infra that referenced this issue Apr 3, 2024
@JeanMeche
refactor(api-gen): add deprecation message and usage notes in class m…
1c0b6ef 
…embers

As reported by angular/angular#55196
josephperrott pushed a commit to angular/dev-infra that referenced this issue Apr 8, 2024
@JeanMeche @josephperrott
refactor(api-gen): add deprecation message and usage notes in class m…
479413e 
…embers (#1955)

As reported by angular/angular#55196

PR Close #1955
@JeanMeche
Copy link
Member

angular/dev-infra#1955 added the usage notes, angular/dev-infra#1964 should add the deprecation messages.

@bencodezen bencodezen added the P2 The issue is important to a large percentage of users, with a workaround label Apr 15, 2024
@ngbot ngbot bot modified the milestones: needsTriage, Backlog Apr 15, 2024
@bencodezen bencodezen added P3 An issue that is relevant to core functions, but does not impede progress. Important, but not urgent and removed P2 The issue is important to a large percentage of users, with a workaround labels Apr 15, 2024
JeanMeche added a commit to JeanMeche/angular that referenced this issue Apr 17, 2024
@JeanMeche
docs: improvements for API pages
df7bc99 
* add link for source files
* add deprecation message for methods
* add usage notes for methods

Fixes angular#55196
Fixes angular#52641
@JeanMeche JeanMeche mentioned this issue Apr 17, 2024
Closed
@alxhub alxhub closed this as completed in 1bea1fe Apr 19, 2024
@angular-automatic-lock-bot
Copy link

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.

@angular-automatic-lock-bot angular-automatic-lock-bot bot locked and limited conversation to collaborators May 20, 2024
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Assignees

@JeanMeche JeanMeche

Labels
area: adev Angular.dev documentation P3 An issue that is relevant to core functions, but does not impede progress. Important, but not urgent
Projects
None yet
Milestone
Backlog
Development

Successfully merging a pull request may close this issue.

docs: api pages improvements JeanMeche/angular
3 participants
@atscott @JeanMeche @bencodezen