emberjs / emberjs/ember.js

`readonly` has been marked private since 2016

Open
#21,549 1 comment 0 reactions 0 assignees View on GitHub
documentation
Dominant language
TypeScript
Stars
22.6k
Forks
4.2k
Avg merge
3d 12h
Merged PRs (30d)
15

Description

https://github.com/emberjs/ember.js/blob/452b9010defb5e4eef3d9612aa3e369a42693ef8/packages/@ember/-internals/glimmer/lib/helpers/readonly.ts#L118

The `readonly` template helper has been marked private since 2016. However, it does not seem like we deprecated it and it continues to work.

I see two options:

1. Restore the docs to public
2. Add a deprecation for intimate API until the next LTS

I do not believe using readonly is still necessary in any but very old code using ember component.

Contributor guide

Open the contributing guide

Research direction

Read packages/@ember/-internals/glimmer/lib/helpers/readonly.ts around line 118 and inspect how the readonly template helper is currently marked. Resolve whether this issue should restore public documentation or introduce an intimate-API deprecation; done means the chosen policy is reflected consistently.

Written by the indexing model from the issue text.

Assessment

Tech stack
javascript, typescript
Domain
frontend
Issue type
Feature
Difficulty
4/5
Estimated time
3-5 days
Activity status
Quiet
Clarity
Mostly clear
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.