Skip to content

docs: use "true" and "false" consistently in the reference documentation#2330

Merged
tonyandrewmeyer merged 5 commits intocanonical:mainfrom
tonyandrewmeyer:doc-true-consistency
Feb 19, 2026
Merged

docs: use "true" and "false" consistently in the reference documentation#2330
tonyandrewmeyer merged 5 commits intocanonical:mainfrom
tonyandrewmeyer:doc-true-consistency

Conversation

@tonyandrewmeyer
Copy link
Copy Markdown
Collaborator

Adjust the docstrings so that true and false are used consistently, and also adjust the style guide to explain our practice.

"true" and "false" mean "truth-y" and "false-y". True and False mean the Python objects. We don't use "True" or "False" (unless the capitalisation is from the start of a sentence).

Fixes #2291

Copy link
Copy Markdown
Contributor

@james-garner-canonical james-garner-canonical left a comment

Choose a reason for hiding this comment

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

Changes look good and more consistent than we had previously. The updated contribution guidance is nice.

I think sometimes it's not clear whether 'true' or 'True' would fit better, but I think it's a nice improvement just eliminating 'True'.

Co-authored-by: James Garner <james.garner@canonical.com>
@tonyandrewmeyer tonyandrewmeyer merged commit ab892e3 into canonical:main Feb 19, 2026
59 checks passed
@tonyandrewmeyer tonyandrewmeyer deleted the doc-true-consistency branch February 19, 2026 04:30
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.

Use consistent "true" strings in reference documentation

3 participants