Skip to content

Adjust descriptions for boolean and read-only properties #2816

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
Merged
merged 2 commits into from
Mar 28, 2025
Merged

Adjust descriptions for boolean and read-only properties #2816

merged 2 commits into from
Mar 28, 2025

Conversation

foolip
Copy link
Collaborator

@foolip foolip commented Mar 27, 2025

  • Lowercase boolean, except "Boolean value" in json.yml
  • Don't say which properties are read-only
  • Don't say that a property returns something, say what the value is

@foolip
Adjust descriptions for boolean and read-only properties
d8c3e77 
- Lowercase boolean, except "Boolean value" in json.yml
- Don't say which properties are read-only
- Don't say that a property returns something, say what the value is
@github-actions github-actions bot added the feature definition Creating or defining new features or groups of features. label Mar 27, 2025
jamesnw
jamesnw approved these changes Mar 28, 2025
View reviewed changes
Copy link
Collaborator

@jamesnw jamesnw left a comment

Choose a reason for hiding this comment

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

These changes make sense to me. Should any of these rules get added to the Style Guide?

@captainbrosset captainbrosset mentioned this pull request Mar 28, 2025
Open
@captainbrosset
Copy link
Contributor

These changes make sense to me. Should any of these rules get added to the Style Guide?

Filed #2822 for this.

@captainbrosset captainbrosset merged commit 14b81c8 into main Mar 28, 2025
3 checks passed
@captainbrosset captainbrosset deleted the description-tweaks branch March 28, 2025 14:16
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@jamesnw jamesnw jamesnw approved these changes

@captainbrosset captainbrosset captainbrosset approved these changes

Assignees
No one assigned
Labels
feature definition Creating or defining new features or groups of features.
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@foolip @captainbrosset @jamesnw