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.

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

docs: making information about read-only clearer #33193

Closed
wants to merge 8 commits into from

Conversation

CBID2
Copy link
Contributor

@CBID2 CBID2 commented Apr 21, 2024

Description

The first sentence in the :read-only entry was ambiguous. So, I changed the description.

Motivation

Making this change would ensure that developers know how to effectively use this CSS property.

Additional details

Related issues and pull requests

#29140

@CBID2 CBID2 requested review from a team as code owners April 21, 2024 19:29
@CBID2 CBID2 requested review from jpmedley, sideshowbarker and bsmth and removed request for a team April 21, 2024 19:29
@github-actions github-actions bot added Content:CSS Cascading Style Sheets docs Content:WebExt WebExtensions docs Content:WebAPI Web API docs size/m [PR only] 51-500 LoC changed labels Apr 21, 2024
@github-actions github-actions bot added size/xs [PR only] 0-5 LoC changed and removed Content:WebExt WebExtensions docs Content:WebAPI Web API docs size/m [PR only] 51-500 LoC changed labels Apr 21, 2024
Copy link
Contributor

github-actions bot commented Apr 21, 2024

Preview URLs

(comment last updated: 2024-05-29 15:27:26)

@@ -7,7 +7,7 @@ browser-compat: css.selectors.read-only

{{CSSRef}}

The **`:read-only`** [CSS](/en-US/docs/Web/CSS) [pseudo-class](/en-US/docs/Web/CSS/Pseudo-classes) represents an element (such as `input` or `textarea`) that is not editable by the user.
The **`:read-only`** [CSS](/en-US/docs/Web/CSS) [pseudo-class](/en-US/docs/Web/CSS/Pseudo-classes) matches elements that do not match **:`read-write`**, such as an element that a user or checkbox cannot edit.
Copy link
Member

Choose a reason for hiding this comment

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

Say what a feature is rather than what it is not. We should define :read-only without referring to :read-write as the reader will have to fully understand read-write (which should be a link, if we were to use it). this could lead to circular references.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Hi @estelle! :) I made the changes

@bsmth bsmth removed the request for review from jpmedley May 13, 2024 12:25
@CBID2 CBID2 requested a review from estelle May 29, 2024 15:25
@@ -7,7 +7,7 @@ browser-compat: css.selectors.read-only

{{CSSRef}}

The **`:read-only`** [CSS](/en-US/docs/Web/CSS) [pseudo-class](/en-US/docs/Web/CSS/Pseudo-classes) represents an element (such as `input` or `textarea`) that is not editable by the user.
The **`:read-only`** [CSS](/en-US/docs/Web/CSS) [pseudo-class](/en-US/docs/Web/CSS/Pseudo-classes) selects elements that are readable only.
Copy link
Member

Choose a reason for hiding this comment

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

This change basically states "read-only is read only". The original is more helpful. Let's keep the original. Closing.

@estelle estelle closed this May 29, 2024
@CBID2 CBID2 deleted the add-clarity-about--read-only branch May 29, 2024 18:11
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Content:CSS Cascading Style Sheets docs size/xs [PR only] 0-5 LoC changed
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants