Skip to content

docs(signals): correct entityMap signal formatting in documentation#5096

Merged
timdeschryver merged 2 commits intongrx:mainfrom
zakaria-bali:patch-3
Feb 18, 2026
Merged

docs(signals): correct entityMap signal formatting in documentation#5096
timdeschryver merged 2 commits intongrx:mainfrom
zakaria-bali:patch-3

Conversation

@zakaria-bali
Copy link
Contributor

…entation

Fix formatting issue in entity-management.md for entityMap signal.

PR Checklist

Please check if your PR fulfills the following requirements:

PR Type

What kind of change does this PR introduce?

[ ] Bugfix
[ ] Feature
[ ] Code style update (formatting, local variables)
[ ] Refactoring (no functional changes, no api changes)
[ ] Build related changes
[ ] CI related changes
[x] Documentation content changes
[ ] Other... Please describe:

What is the current behavior?

Closes #

What is the new behavior?

Does this PR introduce a breaking change?

[ ] Yes
[x] No

Other information

I was reading the docs and noticed that the > is duplicated. When I checked the GitHub repo, I found that it’s just a typo. However, I also observed that the generic type isn’t shown in the docs—only the base type is, for example Signal<Todo[]> is shown as just Signal.

…entation

Fix formatting issue in entity-management.md for entityMap signal.
@netlify
Copy link

netlify bot commented Feb 17, 2026

Deploy Preview for ngrx-io ready!

Built without sensitive environment variables

Name Link
🔨 Latest commit 924e489
🔍 Latest deploy log https://app.netlify.com/projects/ngrx-io/deploys/6995acb790534c0007220707
😎 Deploy Preview https://deploy-preview-5096--ngrx-io.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify project configuration.

@netlify
Copy link

netlify bot commented Feb 17, 2026

Deploy Preview for ngrx-site-v21 ready!

Name Link
🔨 Latest commit 924e489
🔍 Latest deploy log https://app.netlify.com/projects/ngrx-site-v21/deploys/6995acb7f542f30008720ed8
😎 Deploy Preview https://deploy-preview-5096--ngrx-site-v21.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify project configuration.


- `ids: Signal<EntityId[]>`: An array of all entity IDs.
- `entityMap: Signal<EntityMap<Todo>>`: A map of entities where each key is an ID.
- `entityMap: Signal<EntityMap<Todo>`: A map of entities where each key is an ID.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

the current version is correct - we need two closing angle brackets, one for the EntityMap generic argument, another one for the Signal generic argument

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

image take a look to the presentation there's something wrong in the renderer

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I see. If you want to update the PR, I think that replacing angle brackets with &lt; and &gt; will fix the issue

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Okay I will do it, I will update it.

@markostanimirovic
Copy link
Member

#5096 (comment)

Use HTML entities so generic types (e.g. Signal<EntityId[]>) render correctly.
@markostanimirovic markostanimirovic changed the title docs(entity-management): Correct entityMap signal formatting in docum… docs(signals): correct entityMap signal formatting in documentation Feb 18, 2026
Copy link
Member

@timdeschryver timdeschryver left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks!

@timdeschryver timdeschryver merged commit fe89f5a into ngrx:main Feb 18, 2026
14 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants