Skip to content

Docs/schema only: fix casing, remove more articles#9981

Merged
david-crespo merged 2 commits into
mainfrom
fix-doc-casing
Mar 12, 2026
Merged

Docs/schema only: fix casing, remove more articles#9981
david-crespo merged 2 commits into
mainfrom
fix-doc-casing

Conversation

@david-crespo

@david-crespo david-crespo commented Mar 5, 2026

Copy link
Copy Markdown
Contributor

I noticed while reviewing #9958 that the doc comments on the fields in IdentityMetadata start with a lower-case letter, which is AGAINST THE RULES, so this fixes that. While I was at it, I turned up AssetIdentity, the pagination sort modes, and a couple of fields on the Instance view struct.

Then while working on that I noticed a lot of summaries (first lines) that could be shortened by removing articles and other rewordings. I prefer to keep these short, mostly because they show up in the docs site sidebar:

image

@david-crespo david-crespo changed the title Minor: fix doc comment casing in some shared schemas Minor: fix doc comment casing, remove more articles Mar 12, 2026
@david-crespo david-crespo changed the title Minor: fix doc comment casing, remove more articles Docs/schema only: fix casing, remove more articles Mar 12, 2026

@charliepark charliepark left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Better!

@david-crespo david-crespo enabled auto-merge (squash) March 12, 2026 18:21
@david-crespo david-crespo merged commit 990e9e2 into main Mar 12, 2026
17 checks passed
@david-crespo david-crespo deleted the fix-doc-casing branch March 12, 2026 18:58
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.

2 participants