Update Specifications#4
Conversation
|
Note Reviews pausedIt looks like this branch is under active development. To avoid overwhelming you with review comments due to an influx of new commits, CodeRabbit has automatically paused this review. You can configure this behavior by changing the Use the following commands to manage reviews:
Use the checkboxes below for quick actions:
📝 WalkthroughWalkthroughAdds Markdown table specifications and reusable snippets, extends snippet generation for additional documentation categories, corrects character-table naming and field references, and adds documentation workflow and npm-script updates. ChangesDocumentation generation and workflow
Table architecture and specifications
Character Table documentation
Color Table snippets
Pixmap and Font snippets
Estimated code review effort: 3 (Moderate) | ~30 minutes 🚥 Pre-merge checks | ✅ 4 | ❌ 1❌ Failed checks (1 inconclusive)
✅ Passed checks (4 passed)
✨ Finishing Touches🧪 Generate unit tests (beta)
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 1
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
Inline comments:
In
`@snippets/character_table/configurations/condition/constant_codepoint_count.md`:
- Line 1: The sentence "If `use_constant_codepoint_count` enabled." is missing a
verb; update the wording to "If `use_constant_codepoint_count` is enabled." (or
an equivalent grammatically correct variant) in the documentation snippet for
the condition referencing use_constant_codepoint_count to restore readability;
locate the phrase in the
character_table/configurations/condition/constant_codepoint_count.md content and
insert "is" after the backticked variable name.
🪄 Autofix (Beta)
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
ℹ️ Review info
⚙️ Run configuration
Configuration used: defaults
Review profile: CHILL
Plan: Pro Plus
Run ID: 84effb04-6767-4f99-8710-4a07407c93a2
📒 Files selected for processing (1)
snippets/character_table/configurations/condition/constant_codepoint_count.md
There was a problem hiding this comment.
Actionable comments posted: 10
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
Inline comments:
In `@scripts/snippet-tool.ts`:
- Line 98: generateStructure now writes link flag files to links/flag using
writePlaceholder (e.g., writePlaceholder(... "links/flag", ...)), but the
document builder still loads link-flag docs from links/condition, causing files
under links/flag to be ignored; update the document builder code that currently
reads the "links/condition" directory (search for any loader function or method
that reads "links/condition", e.g., readLinkFlags/readLinks or the code path
that parses condition files) to instead read from "links/flag" (or adjust the
read path to accept both locations), ensuring the reader code and
generateStructure (writePlaceholder) agree on "links/flag" so new link_<name>.md
files are consumed.
In `@snippets/character_table/configurations/brief/constant_code_point_count.md`:
- Line 1: Replace the misspelled term "codepoint" with the project-approved term
"code point" in the documentation line that describes the exact codepoint length
for the `code_points` field (the string containing "codepoint" in the brief
description for constant_code_point_count). Update that single word so the
sentence reads "code point" to satisfy the Vale linter.
In `@snippets/character_table/records/condition/code_points.md`:
- Line 1: The phrase "codepoint" in the `code_points` condition text should use
the repository's accepted spelling "code point"; update the string "UTF-8
encoded codepoint sequence (null-terminated unless `constant_code_point_count`
is set)." to "UTF-8 encoded code point sequence (null-terminated unless
`constant_code_point_count` is set)." in the `code_points` condition
documentation so Vale no longer flags it.
In `@snippets/color_table/brief.md`:
- Around line 1-6: The brief uses non-conforming casing for the term
"pixmap"/"Pixmap"; update all occurrences in this file to the project's accepted
glossary form (use "pixmap" consistently) so lint (Vale) passes; edit the lines
in the description and list items that reference Pixmap Table or pixmap palettes
to use "pixmap" lowercase and ensure surrounding phrasing remains grammatical.
In `@snippets/color_table/records/condition/color_type.md`:
- Around line 1-3: Update the documentation so the heading and prose use
human-readable text instead of the underscored identifier: change the heading
from "# color_type" to something like "# Color type" and replace occurrences of
plain `color_type` in the body with human-readable phrases such as "color type",
reserving the backticked `color_type` only when referencing the exact schema
identifier or code example; ensure the file still documents the schema named
`color_type` but uses natural language for headings and explanatory sentences.
In `@snippets/font_table/records/condition/character_table_indexes.md`:
- Around line 1-3: Change the Markdown heading to sentence-style text and
mention the field name as inline code in the body: replace the all-lowercase
heading "character_table_indexes" with a sentence-style heading (e.g.,
"Character table indexes") and update the body to refer to the identifier as
`character_table_indexes` within prose so Vale accepts heading/body token usage
while preserving the exact field name.
In `@snippets/font_table/records/condition/font_type.md`:
- Around line 1-3: The heading and body use a raw underscored token that fails
Vale; change the heading from the underscored markdown heading to sentence case
(e.g., "Font type") and rewrite the body sentence to use normal sentence style
while keeping the exact identifier as inline code (`font_type`) where
referenced; update the first line to a sentence-style heading and replace the
body line "Write the documentation content for font_type here." with a proper
sentence that refers to `font_type` in backticks.
In `@src/Character` Table.md:
- Line 58: The table row for the `code_points` field uses a wrong snippet
include path
`\textinput{../snippets/character_table/records/brief/codepoints.md}` which
doesn't exist; update that include to the correct filename
`\textinput{../snippets/character_table/records/brief/code_points.md}` in the
`code_points` table row so the brief snippet matches the actual `code_points.md`
file.
In `@src/Color` Table.md:
- Around line 52-58: Add a language tag to both fenced code blocks containing
"[EXAMPLE_PLACEHOLDER]" so markdownlint stops warning: replace the opening ```
with ```text for the code block under the "Example 2: With optional fields"
section and the earlier example block (the two occurrences of
"[EXAMPLE_PLACEHOLDER]" around lines 52 and 57) so both fenced blocks become
```text ... ```; no other changes needed.
- Around line 67-70: Replace the lint-violating header text "Byte(s)" with
"Bytes" in the table header and replace the literal "..." cells in the second
row with lint-compliant phrasing such as "Additional rows" (for the
Byte(s)/Bytes column) and "Other entries" or "More values" as appropriate; also
keep the placeholder tokens `[BINARY_PLACEHOLDER]`, `[HEX_PLACEHOLDER]`, and
`[DESCRIPTION_PLACEHOLDER]` intact but ensure their surrounding cell text is
updated so the row reads like: Bytes | `[BINARY_PLACEHOLDER]` |
`[HEX_PLACEHOLDER]` | `[DESCRIPTION_PLACEHOLDER]` with the second-row first cell
using "Additional rows" instead of "...".
🪄 Autofix (Beta)
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
ℹ️ Review info
⚙️ Run configuration
Configuration used: defaults
Review profile: CHILL
Plan: Pro Plus
Run ID: 9535a640-841b-47ea-8d00-5489ec8db1ed
⛔ Files ignored due to path filters (1)
vale.logis excluded by!**/*.log
📒 Files selected for processing (40)
package.jsonscripts/snippet-tool.tssnippets/character_table/configurations/brief/constant_code_point_count.mdsnippets/character_table/configurations/brief/constant_codepoint_count.mdsnippets/character_table/configurations/condition/constant_code_point_count.mdsnippets/character_table/configurations/condition/constant_codepoint_count.mdsnippets/character_table/configurations/flag/use_constant_code_point_count.mdsnippets/character_table/configurations/flag/use_constant_codepoint_count.mdsnippets/character_table/records/brief/code_points.mdsnippets/character_table/records/condition/code_points.mdsnippets/color_table/brief.mdsnippets/color_table/configurations/brief/constant_alpha.mdsnippets/color_table/configurations/condition/constant_alpha.mdsnippets/color_table/configurations/flag/use_constant_alpha.mdsnippets/color_table/records/condition/alpha.mdsnippets/color_table/records/condition/blue.mdsnippets/color_table/records/condition/color_type.mdsnippets/color_table/records/condition/green.mdsnippets/color_table/records/condition/red.mdsnippets/font_table/links/condition/character_tables.mdsnippets/font_table/links/flag/link_character_tables.mdsnippets/font_table/records/condition/author.mdsnippets/font_table/records/condition/character_table_indexes.mdsnippets/font_table/records/condition/font_type.mdsnippets/font_table/records/condition/name.mdsnippets/font_table/records/condition/version.mdsnippets/pixmap_table/configurations/condition/constant_bits_per_pixel.mdsnippets/pixmap_table/configurations/condition/constant_height.mdsnippets/pixmap_table/configurations/condition/constant_width.mdsnippets/pixmap_table/configurations/flag/use_constant_bits_per_pixel.mdsnippets/pixmap_table/configurations/flag/use_constant_height.mdsnippets/pixmap_table/configurations/flag/use_constant_width.mdsnippets/pixmap_table/links/condition/color_tables.mdsnippets/pixmap_table/links/flag/link_color_tables.mdsnippets/pixmap_table/records/condition/bits_per_pixel.mdsnippets/pixmap_table/records/condition/data.mdsnippets/pixmap_table/records/condition/height.mdsnippets/pixmap_table/records/condition/width.mdsrc/Character Table.mdsrc/Color Table.md
💤 Files with no reviewable changes (4)
- snippets/character_table/configurations/brief/constant_codepoint_count.md
- snippets/character_table/configurations/flag/use_constant_codepoint_count.md
- snippets/color_table/configurations/brief/constant_alpha.md
- snippets/character_table/configurations/condition/constant_codepoint_count.md
✅ Files skipped from review due to trivial changes (14)
- snippets/character_table/configurations/flag/use_constant_code_point_count.md
- snippets/pixmap_table/records/condition/height.md
- snippets/pixmap_table/configurations/flag/use_constant_height.md
- snippets/pixmap_table/configurations/flag/use_constant_width.md
- snippets/pixmap_table/configurations/condition/constant_width.md
- snippets/font_table/records/condition/name.md
- snippets/pixmap_table/configurations/condition/constant_bits_per_pixel.md
- package.json
- snippets/pixmap_table/records/condition/width.md
- snippets/pixmap_table/configurations/condition/constant_height.md
- snippets/pixmap_table/records/condition/bits_per_pixel.md
- snippets/font_table/records/condition/version.md
- snippets/pixmap_table/records/condition/data.md
- snippets/pixmap_table/configurations/flag/use_constant_bits_per_pixel.md
| @@ -1 +1 @@ | |||
| UTF-8 encoded codepoint sequence (null-terminated unless `constant_codepoint_count` is set). No newline at end of file | |||
| UTF-8 encoded codepoint sequence (null-terminated unless `constant_code_point_count` is set). No newline at end of file | |||
There was a problem hiding this comment.
Fix CI-blocking spelling in code_points condition text.
Vale fails on codepoint here as well. Please switch to code point (or the repository’s accepted spelling).
🧰 Tools
🪛 GitHub Actions: vale / 1_vale.txt
[error] 1-1: Vale.Spelling: Did you really mean 'codepoint'?
🪛 GitHub Actions: vale / vale
[error] 1-1: [Vale.Spelling] Did you really mean 'codepoint'?
🪛 GitHub Check: vale
[notice] 1-1: [vale] snippets/character_table/records/condition/code_points.md#L1
[Google.Parens] Use parentheses judiciously.
[failure] 1-1: [vale] snippets/character_table/records/condition/code_points.md#L1
[Vale.Spelling] Did you really mean 'codepoint'?
[notice] 1-1: [vale] snippets/character_table/records/condition/code_points.md#L1
[write-good.E-Prime] Try to avoid using 'is'.
[notice] 1-1: [vale] snippets/character_table/records/condition/code_points.md#L1
[Google.Passive] In general, use active voice instead of passive voice ('is set').
[warning] 1-1: [vale] snippets/character_table/records/condition/code_points.md#L1
[write-good.Passive] 'is set' may be passive voice. Use active voice if you can.
🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
In `@snippets/character_table/records/condition/code_points.md` at line 1, The
phrase "codepoint" in the `code_points` condition text should use the
repository's accepted spelling "code point"; update the string "UTF-8 encoded
codepoint sequence (null-terminated unless `constant_code_point_count` is set)."
to "UTF-8 encoded code point sequence (null-terminated unless
`constant_code_point_count` is set)." in the `code_points` condition
documentation so Vale no longer flags it.
| Stores RGBA color values that can be referenced by pixmap data. | ||
|
|
||
| Write the documentation content for color_table table here. No newline at end of file | ||
| ## Use Cases | ||
|
|
||
| - **Pixmap palettes** - When linked to a Pixmap Table, provides the color palette for indexed pixel data. | ||
| - **Color storage** - Can store color sets independently for other purposes. No newline at end of file |
There was a problem hiding this comment.
Address Vale spelling failures for pixmap/Pixmap in brief content.
This file currently fails lint. Please use lint-approved wording (or the project’s accepted glossary form) so docs checks pass.
🧰 Tools
🪛 GitHub Actions: vale / 1_vale.txt
[error] 1-1: Vale.Spelling: Did you really mean 'pixmap'?
[error] 5-5: Vale.Spelling: Did you really mean 'Pixmap'?
[error] 5-5: Vale.Spelling: Did you really mean 'Pixmap'?
🪛 GitHub Actions: vale / vale
[error] 1-1: [Vale.Spelling] Did you really mean 'pixmap'?
[error] 5-5: [Vale.Spelling] Did you really mean 'Pixmap'?
[error] 5-5: [Vale.Spelling] Did you really mean 'Pixmap'?
🪛 GitHub Check: vale
[notice] 1-1: [vale] snippets/color_table/brief.md#L1
[Google.Acronyms] Spell out 'RGBA', if it's unfamiliar to the audience.
[warning] 1-1: [vale] snippets/color_table/brief.md#L1
[write-good.Passive] 'be referenced' may be passive voice. Use active voice if you can.
[notice] 1-1: [vale] snippets/color_table/brief.md#L1
[write-good.E-Prime] Try to avoid using 'be'.
[notice] 1-1: [vale] snippets/color_table/brief.md#L1
[Google.Passive] In general, use active voice instead of passive voice ('be referenced').
[failure] 1-1: [vale] snippets/color_table/brief.md#L1
[Vale.Spelling] Did you really mean 'pixmap'?
[warning] 3-3: [vale] snippets/color_table/brief.md#L3
[Google.Headings] 'Use Cases' should use sentence-style capitalization.
[failure] 5-5: [vale] snippets/color_table/brief.md#L5
[Vale.Spelling] Did you really mean 'Pixmap'?
[failure] 5-5: [vale] snippets/color_table/brief.md#L5
[Vale.Spelling] Did you really mean 'Pixmap'?
🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
In `@snippets/color_table/brief.md` around lines 1 - 6, The brief uses
non-conforming casing for the term "pixmap"/"Pixmap"; update all occurrences in
this file to the project's accepted glossary form (use "pixmap" consistently) so
lint (Vale) passes; edit the lines in the description and list items that
reference Pixmap Table or pixmap palettes to use "pixmap" lowercase and ensure
surrounding phrasing remains grammatical.
| # color_type | ||
|
|
||
| Write the documentation content for color_type here. No newline at end of file |
There was a problem hiding this comment.
Replace underscore identifier prose to pass Vale (color_type).
This file fails lint on color_type. Use human-readable text (e.g., “color type”) in heading/body while keeping schema identifiers in backticks only where necessary.
🧰 Tools
🪛 GitHub Actions: vale / 1_vale.txt
[error] 1-1: Vale.Spelling: Did you really mean 'color_type'?
[error] 3-3: Vale.Spelling: Did you really mean 'color_type'?
🪛 GitHub Actions: vale / vale
[error] 1-1: [Vale.Spelling] Did you really mean 'color_type'?
[error] 3-3: [Vale.Spelling] Did you really mean 'color_type'?
🪛 GitHub Check: vale
[failure] 1-1: [vale] snippets/color_table/records/condition/color_type.md#L1
[Vale.Spelling] Did you really mean 'color_type'?
[warning] 1-1: [vale] snippets/color_table/records/condition/color_type.md#L1
[Google.Headings] 'color_type' should use sentence-style capitalization.
[failure] 3-3: [vale] snippets/color_table/records/condition/color_type.md#L3
[Vale.Spelling] Did you really mean 'color_type'?
🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
In `@snippets/color_table/records/condition/color_type.md` around lines 1 - 3,
Update the documentation so the heading and prose use human-readable text
instead of the underscored identifier: change the heading from "# color_type" to
something like "# Color type" and replace occurrences of plain `color_type` in
the body with human-readable phrases such as "color type", reserving the
backticked `color_type` only when referencing the exact schema identifier or
code example; ensure the file still documents the schema named `color_type` but
uses natural language for headings and explanatory sentences.
| # character_table_indexes | ||
|
|
||
| Write the documentation content for character_table_indexes here. No newline at end of file |
There was a problem hiding this comment.
Fix Vale spelling failures in heading/body token usage (Line 1, Line 3).
character_table_indexes is currently triggering pipeline errors. Use sentence-style heading text and reference the identifier as inline code in prose to satisfy Vale while keeping the exact field name.
Suggested patch
-# character_table_indexes
+# Character table indexes
-Write the documentation content for character_table_indexes here.
+Write the documentation content for `character_table_indexes` here.📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
| # character_table_indexes | |
| Write the documentation content for character_table_indexes here. | |
| # Character table indexes | |
| Write the documentation content for `character_table_indexes` here. |
🧰 Tools
🪛 GitHub Actions: vale / 1_vale.txt
[error] 1-1: Vale.Spelling: Did you really mean 'character_table_indexes'?
[error] 3-3: Vale.Spelling: Did you really mean 'character_table_indexes'?
🪛 GitHub Check: vale
[failure] 1-1: [vale] snippets/font_table/records/condition/character_table_indexes.md#L1
[Vale.Spelling] Did you really mean 'character_table_indexes'?
[warning] 1-1: [vale] snippets/font_table/records/condition/character_table_indexes.md#L1
[Google.Headings] 'character_table_indexes' should use sentence-style capitalization.
🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
In `@snippets/font_table/records/condition/character_table_indexes.md` around
lines 1 - 3, Change the Markdown heading to sentence-style text and mention the
field name as inline code in the body: replace the all-lowercase heading
"character_table_indexes" with a sentence-style heading (e.g., "Character table
indexes") and update the body to refer to the identifier as
`character_table_indexes` within prose so Vale accepts heading/body token usage
while preserving the exact field name.
| # font_type | ||
|
|
||
| Write the documentation content for font_type here. No newline at end of file |
There was a problem hiding this comment.
Resolve CI-breaking spelling errors for font_type (Line 1, Line 3).
The raw underscored token is failing Vale in both the heading and body. Switch heading to sentence style and keep the exact identifier in inline code where needed.
Suggested patch
-# font_type
+# Font type
-Write the documentation content for font_type here.
+Write the documentation content for `font_type` here.📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
| # font_type | |
| Write the documentation content for font_type here. | |
| # Font type | |
| Write the documentation content for `font_type` here. |
🧰 Tools
🪛 GitHub Actions: vale / 1_vale.txt
[error] 1-1: Vale.Spelling: Did you really mean 'font_type'?
[error] 3-3: Vale.Spelling: Did you really mean 'font_type'?
🪛 GitHub Check: vale
[failure] 1-1: [vale] snippets/font_table/records/condition/font_type.md#L1
[Vale.Spelling] Did you really mean 'font_type'?
[warning] 1-1: [vale] snippets/font_table/records/condition/font_type.md#L1
[Google.Headings] 'font_type' should use sentence-style capitalization.
[failure] 3-3: [vale] snippets/font_table/records/condition/font_type.md#L3
[Vale.Spelling] Did you really mean 'font_type'?
🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
In `@snippets/font_table/records/condition/font_type.md` around lines 1 - 3, The
heading and body use a raw underscored token that fails Vale; change the heading
from the underscored markdown heading to sentence case (e.g., "Font type") and
rewrite the body sentence to use normal sentence style while keeping the exact
identifier as inline code (`font_type`) where referenced; update the first line
to a sentence-style heading and replace the body line "Write the documentation
content for font_type here." with a proper sentence that refers to `font_type`
in backticks.
| ``` | ||
| [EXAMPLE_PLACEHOLDER] | ||
| ``` | ||
|
|
||
| **Example 2: With optional fields** | ||
| ``` | ||
| [EXAMPLE_PLACEHOLDER] |
There was a problem hiding this comment.
Add language tags to fenced code blocks (Line 52, Line 57).
This removes markdownlint warnings and keeps docs tooling clean.
Suggested patch
-```
+```text
[EXAMPLE_PLACEHOLDER]...
- +text
[EXAMPLE_PLACEHOLDER]
🧰 Tools
🪛 markdownlint-cli2 (0.22.1)
[warning] 52-52: Fenced code blocks should have a language specified
(MD040, fenced-code-language)
[warning] 57-57: Fenced code blocks should have a language specified
(MD040, fenced-code-language)
🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
In `@src/Color` Table.md around lines 52 - 58, Add a language tag to both fenced
code blocks containing "[EXAMPLE_PLACEHOLDER]" so markdownlint stops warning:
replace the opening ``` with ```text for the code block under the "Example 2:
With optional fields" section and the earlier example block (the two occurrences
of "[EXAMPLE_PLACEHOLDER]" around lines 52 and 57) so both fenced blocks become
```text ... ```; no other changes needed.
| | Byte(s) | Binary | Hex | Description | | ||
| | ------- | ------ | --- | ----------- | | ||
| | 1 | `[BINARY_PLACEHOLDER]` | `[HEX_PLACEHOLDER]` | Table identifier | | ||
| | ... | ... | ... | [DESCRIPTION_PLACEHOLDER] | No newline at end of file |
There was a problem hiding this comment.
Fix Vale failures in the table example header/text (Line 67, Line 70).
Current wording is failing CI: Byte(s) and .... Replace with lint-compliant phrasing.
Suggested patch
-| Byte(s) | Binary | Hex | Description |
+| Bytes | Binary | Hex | Description |
...
-| ... | ... | ... | [DESCRIPTION_PLACEHOLDER] |
+| … | … | … | [DESCRIPTION_PLACEHOLDER] |📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
| | Byte(s) | Binary | Hex | Description | | |
| | ------- | ------ | --- | ----------- | | |
| | 1 | `[BINARY_PLACEHOLDER]` | `[HEX_PLACEHOLDER]` | Table identifier | | |
| | ... | ... | ... | [DESCRIPTION_PLACEHOLDER] | | |
| | Bytes | Binary | Hex | Description | | |
| | ------- | ------ | --- | ----------- | | |
| | 1 | `[BINARY_PLACEHOLDER]` | `[HEX_PLACEHOLDER]` | Table identifier | | |
| | … | … | … | [DESCRIPTION_PLACEHOLDER] | |
🧰 Tools
🪛 GitHub Actions: vale / 1_vale.txt
[error] 67-67: Google.OptionalPlurals: Don't use plurals in parentheses such as in 'Byte(s)'.
[error] 70-70: proselint.Typography: Consider using the '…' symbol instead of '...'.
🪛 GitHub Actions: vale / vale
[error] 67-67: [Google.OptionalPlurals] Don't use plurals in parentheses such as in 'Byte(s)'.
[error] 70-70: [proselint.Typography] Consider using the '…' symbol instead of '...'.
[error] 70-70: [proselint.Typography] Consider using the '…' symbol instead of '...'.
[error] 70-70: [proselint.Typography] Consider using the '…' symbol instead of '...'.
🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
In `@src/Color` Table.md around lines 67 - 70, Replace the lint-violating header
text "Byte(s)" with "Bytes" in the table header and replace the literal "..."
cells in the second row with lint-compliant phrasing such as "Additional rows"
(for the Byte(s)/Bytes column) and "Other entries" or "More values" as
appropriate; also keep the placeholder tokens `[BINARY_PLACEHOLDER]`,
`[HEX_PLACEHOLDER]`, and `[DESCRIPTION_PLACEHOLDER]` intact but ensure their
surrounding cell text is updated so the row reads like: Bytes |
`[BINARY_PLACEHOLDER]` | `[HEX_PLACEHOLDER]` | `[DESCRIPTION_PLACEHOLDER]` with
the second-row first cell using "Additional rows" instead of "...".
There was a problem hiding this comment.
Actionable comments posted: 1
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
Inline comments:
In @.github/workflows/wiki.yml:
- Line 7: The workflow triggered by pushes to the documentation branch uses
mutable third-party references; update .github/workflows/wiki.yml to pin
actions/checkout@v2 and newrelic/wiki-sync-action@main to specific commit SHAs
(replace `@v2` and `@main` with the corresponding full commit SHA refs) and remove
the remote npx git invocation (npx https://github.com/The-Nice-One/rail-yard.git
...) by replacing it with a pinned package version or vendored script in the
repo; ensure the updated entries reference immutable SHAs and the npx call is
replaced with a vetted dependency or local script so CI no longer executes code
from an upstream mutable URL.
🪄 Autofix (Beta)
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
ℹ️ Review info
⚙️ Run configuration
Configuration used: defaults
Review profile: CHILL
Plan: Pro Plus
Run ID: edb02732-50c1-45df-93b8-ea063576cab0
📒 Files selected for processing (3)
.github/workflows/wiki.ymlsnippets/color_table/modifiers/brief/use_color_type.mdsrc/Character Table.md
💤 Files with no reviewable changes (1)
- snippets/color_table/modifiers/brief/use_color_type.md
✅ Files skipped from review due to trivial changes (1)
- src/Character Table.md
There was a problem hiding this comment.
Actionable comments posted: 9
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
Inline comments:
In `@snippets/character_table/links/brief/pixmap_tables.md`:
- Line 1: Resolve the Vale spelling failures by registering the approved project
terminology in the Vale vocabulary or normalizing the prose consistently: update
Pixmap in snippets/character_table/links/brief/pixmap_tables.md (1-1), codepoint
in snippets/character_table/records/brief/code_points.md (1-1), pixmap/Pixmap in
snippets/character_table/records/brief/pixmap_index.md (1-1), Pixmap in
snippets/character_table/records/brief/pixmap_table_index.md (1-1), and
pixmap/Pixmap in src/Character Table.md (64-64, 81-100, and 127-127).
In `@snippets/character_table/records/brief/pixmap_index.md`:
- Line 1: Update the pixmap index description to replace the ambiguous
“Table(s)” wording with the explicit plural phrase “the referenced Pixmap
Tables,” preserving the rest of the description.
In `@snippets/color_table/modifiers/details/use_color_type.md`:
- Line 1: Fix the punctuation and wording in the “but not limited to” sentence
within the default color type description, using a colon or the suggested
rewrite while preserving the original meaning.
In `@snippets/pixmap_table/brief.md`:
- Line 1: Register the valid Pixmap terminology in the Vale vocabulary: add
pixmap and pixmaps for snippets/pixmap_table/brief.md lines 1-1 and 5-5, pixmaps
for each configuration brief at the specified lines, and pixmap, pixmaps, and
Pixmap for the listed occurrences in src/Pixmap Table.md lines 63, 168, 172,
181-187, and 193.
In `@snippets/pixmap_table/configurations/flag/use_constant_bits_per_pixel.md`:
- Line 1: Add pixmaps to Vale’s accepted vocabulary/configuration so the
existing domain terminology passes validation. Preserve the wording in
snippets/pixmap_table/configurations/flag/use_constant_bits_per_pixel.md lines
1-1 and snippets/pixmap_table/configurations/flag/use_constant_height.md lines
1-1 without edits.
In `@snippets/pixmap_table/records/brief/bits_per_pixel.md`:
- Line 1: Add “pixmap” to the shared Vale spelling vocabulary while preserving
the existing terminology in
snippets/pixmap_table/records/brief/bits_per_pixel.md lines 1-1, height.md lines
1-1, and width.md lines 1-1; no changes are needed in those documentation files.
In `@src/Character` Table.md:
- Around line 71-73: Update the “Example 2: With custom advance” description for
character W to hyphenate the compound modifier as “12-pixel advance,” preserving
the rest of the documentation unchanged.
In `@src/Pixmap` Table.md:
- Around line 55-59: Update the complete_bytes_used formula in the quantity
table to use floor(total_bits / 8), or equivalent integer division, so partial
bytes are excluded while remainder_bits continues to represent the leftover
bits.
- Line 170: Update the table header from “Byte(s)” to “Bytes” in both complete
examples: src/Pixmap Table.md lines 170-170 and src/Color Table.md lines
100-100.
🪄 Autofix (Beta)
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
ℹ️ Review info
⚙️ Run configuration
Configuration used: defaults
Review profile: CHILL
Plan: Pro Plus
Run ID: f9042d8c-b72a-47cb-b283-2bf775bf8499
📒 Files selected for processing (47)
scripts/snippet-tool.tssnippets/character_table/links/brief/pixmap_tables.mdsnippets/character_table/records/brief/code_points.mdsnippets/character_table/records/brief/pixmap_index.mdsnippets/character_table/records/brief/pixmap_table_index.mdsnippets/character_table/records/condition/code_points.mdsnippets/character_table/records/condition/pixmap_index.mdsnippets/character_table/records/condition/pixmap_table_index.mdsnippets/color_table/configurations/brief/constant_alpha.mdsnippets/color_table/configurations/condition/constant_alpha.mdsnippets/color_table/configurations/flag/use_constant_alpha.mdsnippets/color_table/modifiers/brief/use_color_type.mdsnippets/color_table/modifiers/details/use_color_type.mdsnippets/color_table/records/brief/alpha.mdsnippets/color_table/records/brief/blue.mdsnippets/color_table/records/brief/color_type.mdsnippets/color_table/records/brief/green.mdsnippets/color_table/records/brief/red.mdsnippets/color_table/records/condition/alpha.mdsnippets/color_table/records/condition/blue.mdsnippets/color_table/records/condition/color_type.mdsnippets/color_table/records/condition/green.mdsnippets/color_table/records/condition/red.mdsnippets/pixmap_table/brief.mdsnippets/pixmap_table/configurations/brief/constant_bits_per_pixel.mdsnippets/pixmap_table/configurations/brief/constant_height.mdsnippets/pixmap_table/configurations/brief/constant_width.mdsnippets/pixmap_table/configurations/condition/constant_bits_per_pixel.mdsnippets/pixmap_table/configurations/condition/constant_height.mdsnippets/pixmap_table/configurations/condition/constant_width.mdsnippets/pixmap_table/configurations/flag/use_constant_bits_per_pixel.mdsnippets/pixmap_table/configurations/flag/use_constant_height.mdsnippets/pixmap_table/configurations/flag/use_constant_width.mdsnippets/pixmap_table/links/brief/color_tables.mdsnippets/pixmap_table/links/condition/color_tables.mdsnippets/pixmap_table/links/flag/link_color_tables.mdsnippets/pixmap_table/records/brief/bits_per_pixel.mdsnippets/pixmap_table/records/brief/data.mdsnippets/pixmap_table/records/brief/height.mdsnippets/pixmap_table/records/brief/width.mdsnippets/pixmap_table/records/condition/bits_per_pixel.mdsnippets/pixmap_table/records/condition/data.mdsnippets/pixmap_table/records/condition/height.mdsnippets/pixmap_table/records/condition/width.mdsrc/Character Table.mdsrc/Color Table.mdsrc/Pixmap Table.md
🚧 Files skipped from review as they are similar to previous changes (4)
- snippets/color_table/records/condition/red.md
- snippets/color_table/configurations/brief/constant_alpha.md
- snippets/character_table/records/condition/code_points.md
- scripts/snippet-tool.ts
| @@ -1 +1 @@ | |||
| Vector of Pixmap Table indices this character table references. No newline at end of file | |||
| Length byte followed by that many Pixmap Table indices this character table may reference. | |||
There was a problem hiding this comment.
📐 Maintainability & Code Quality | 🟠 Major | ⚡ Quick win
Resolve the Vale spelling failures for repository-specific terminology.
Add the approved Pixmap/pixmap and code-point terminology to the Vale vocabulary, or normalize the prose to the project’s accepted spellings. These failures currently block the Vale workflow.
snippets/character_table/links/brief/pixmap_tables.md#L1-L1: registerPixmap.snippets/character_table/records/brief/code_points.md#L1-L1: register or normalizecodepoint.snippets/character_table/records/brief/pixmap_index.md#L1-L1: register or normalizepixmapandPixmap.snippets/character_table/records/brief/pixmap_table_index.md#L1-L1: registerPixmap.src/Character Table.md#L64-L64: resolve the flaggedpixmapspelling.src/Character Table.md#L81-L100: resolve the flaggedpixmap/Pixmapspellings.src/Character Table.md#L127-L127: resolve the flaggedPixmapspelling.
🧰 Tools
🪛 GitHub Actions: vale / 1_vale.txt
[error] 1-1: [Vale.Spelling] Did you really mean 'Pixmap'?
🪛 GitHub Actions: vale / vale
[error] 1-1: Vale.Spelling: Did you really mean 'Pixmap'?
🪛 GitHub Check: vale
[failure] 1-1: [vale] snippets/character_table/links/brief/pixmap_tables.md#L1
[Vale.Spelling] Did you really mean 'Pixmap'?
📍 Affects 5 files
snippets/character_table/links/brief/pixmap_tables.md#L1-L1(this comment)snippets/character_table/records/brief/code_points.md#L1-L1snippets/character_table/records/brief/pixmap_index.md#L1-L1snippets/character_table/records/brief/pixmap_table_index.md#L1-L1src/Character Table.md#L64-L64src/Character Table.md#L81-L100src/Character Table.md#L127-L127
🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
In `@snippets/character_table/links/brief/pixmap_tables.md` at line 1, Resolve the
Vale spelling failures by registering the approved project terminology in the
Vale vocabulary or normalizing the prose consistently: update Pixmap in
snippets/character_table/links/brief/pixmap_tables.md (1-1), codepoint in
snippets/character_table/records/brief/code_points.md (1-1), pixmap/Pixmap in
snippets/character_table/records/brief/pixmap_index.md (1-1), Pixmap in
snippets/character_table/records/brief/pixmap_table_index.md (1-1), and
pixmap/Pixmap in src/Character Table.md (64-64, 81-100, and 127-127).
Source: Pipeline failures
| # use_color_type details | ||
|
|
||
| Write the documentation content for use_color_type details here. No newline at end of file | ||
| When disabled, the default color type is dynamic. The rendering engine may change the RGBA color to support features such as, but not limited to; text color, and/or palette theming. No newline at end of file |
There was a problem hiding this comment.
📐 Maintainability & Code Quality | 🟡 Minor | ⚡ Quick win
Fix the punctuation in the “but not limited to” clause.
Use a colon or rewrite the sentence, for example: “The rendering engine may change the RGBA color for text-color changes and palette theming.”
🧰 Tools
🪛 GitHub Check: vale
[warning] 1-1: [vale] snippets/color_table/modifiers/details/use_color_type.md#L1
[Google.WordList] Use 'turn off' or 'off' instead of 'disabled'.
[notice] 1-1: [vale] snippets/color_table/modifiers/details/use_color_type.md#L1
[write-good.E-Prime] Try to avoid using 'is'.
[notice] 1-1: [vale] snippets/color_table/modifiers/details/use_color_type.md#L1
[Google.Acronyms] Spell out 'RGBA', if it's unfamiliar to the audience.
[notice] 1-1: [vale] snippets/color_table/modifiers/details/use_color_type.md#L1
[Google.Semicolons] Use semicolons judiciously.
🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
In `@snippets/color_table/modifiers/details/use_color_type.md` at line 1, Fix the
punctuation and wording in the “but not limited to” sentence within the default
color type description, using a colon or the suggested rewrite while preserving
the original meaning.
Source: Linters/SAST tools
| @@ -1,3 +1,5 @@ | |||
| # pixmap_table table | |||
| Stores glyph data as collections of pixels within pixmaps, representing the visual appearance of a character. | |||
There was a problem hiding this comment.
📐 Maintainability & Code Quality | 🟠 Major | ⚡ Quick win
Add Pixmap terminology to the Vale vocabulary. These valid specification terms currently fail documentation CI.
snippets/pixmap_table/brief.md#L1-L1,L5-L5: registerpixmapandpixmaps.snippets/pixmap_table/configurations/brief/constant_bits_per_pixel.md#L1-L1: registerpixmaps.snippets/pixmap_table/configurations/brief/constant_height.md#L1-L1: registerpixmaps.snippets/pixmap_table/configurations/brief/constant_width.md#L1-L1: registerpixmaps.src/Pixmap Table.md#L63-L63,L168-L168,L172-L172,L181-L187,L193-L193: registerpixmap,pixmaps, andPixmap.
🧰 Tools
🪛 GitHub Actions: vale / 1_vale.txt
[error] 1-1: [Vale.Spelling] Did you really mean 'pixmap'?
🪛 GitHub Actions: vale / vale
[error] 1-1: Vale.Spelling: Did you really mean 'pixmaps'?
🪛 GitHub Check: vale
[failure] 1-1: [vale] snippets/pixmap_table/brief.md#L1
[Vale.Spelling] Did you really mean 'pixmaps'?
📍 Affects 5 files
snippets/pixmap_table/brief.md#L1-L1(this comment)snippets/pixmap_table/brief.md#L5-L5snippets/pixmap_table/configurations/brief/constant_bits_per_pixel.md#L1-L1snippets/pixmap_table/configurations/brief/constant_height.md#L1-L1snippets/pixmap_table/configurations/brief/constant_width.md#L1-L1src/Pixmap Table.md#L63-L63src/Pixmap Table.md#L168-L168src/Pixmap Table.md#L172-L172src/Pixmap Table.md#L181-L187src/Pixmap Table.md#L193-L193
🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
In `@snippets/pixmap_table/brief.md` at line 1, Register the valid Pixmap
terminology in the Vale vocabulary: add pixmap and pixmaps for
snippets/pixmap_table/brief.md lines 1-1 and 5-5, pixmaps for each configuration
brief at the specified lines, and pixmap, pixmaps, and Pixmap for the listed
occurrences in src/Pixmap Table.md lines 63, 168, 172, 181-187, and 193.
Source: Pipeline failures
| @@ -0,0 +1 @@ | |||
| All pixmaps in this table use the same number of bits to represent a pixel. No newline at end of file | |||
There was a problem hiding this comment.
📐 Maintainability & Code Quality | 🟡 Minor | ⚡ Quick win
Add pixmaps to Vale’s accepted vocabulary.
Both documentation lines use the project’s domain term pixmaps, but Vale currently fails the pipeline on that spelling. Update the Vale vocabulary/configuration rather than rewriting both valid descriptions.
snippets/pixmap_table/configurations/flag/use_constant_bits_per_pixel.md#L1-L1: retain the wording after configuring Vale to acceptpixmaps.snippets/pixmap_table/configurations/flag/use_constant_height.md#L1-L1: retain the wording after configuring Vale to acceptpixmaps.
🧰 Tools
🪛 GitHub Actions: vale / 1_vale.txt
[error] 1-1: [Vale.Spelling] Did you really mean 'pixmaps'?
🪛 GitHub Actions: vale / vale
[error] 1-1: Vale.Spelling: Did you really mean 'pixmaps'?
🪛 GitHub Check: vale
[failure] 1-1: [vale] snippets/pixmap_table/configurations/flag/use_constant_bits_per_pixel.md#L1
[Vale.Spelling] Did you really mean 'pixmaps'?
📍 Affects 2 files
snippets/pixmap_table/configurations/flag/use_constant_bits_per_pixel.md#L1-L1(this comment)snippets/pixmap_table/configurations/flag/use_constant_height.md#L1-L1
🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
In `@snippets/pixmap_table/configurations/flag/use_constant_bits_per_pixel.md` at
line 1, Add pixmaps to Vale’s accepted vocabulary/configuration so the existing
domain terminology passes validation. Preserve the wording in
snippets/pixmap_table/configurations/flag/use_constant_bits_per_pixel.md lines
1-1 and snippets/pixmap_table/configurations/flag/use_constant_height.md lines
1-1 without edits.
Sources: Linters/SAST tools, Pipeline failures
| # bits_per_pixel | ||
|
|
||
| Write the documentation content for bits_per_pixel here. No newline at end of file | ||
| Bits used to represent each pixel of this pixmap (only 1-8 supported). |
There was a problem hiding this comment.
📐 Maintainability & Code Quality | 🟠 Major | ⚡ Quick win
Fix the shared Vale vocabulary issue for pixmap.
The documentation pipeline fails because Vale does not recognize this intentional domain term. Add pixmap to the project spelling vocabulary so all affected snippets pass without changing the specification terminology.
snippets/pixmap_table/records/brief/bits_per_pixel.md#L1: preservepixmapand update the Vale dictionary.snippets/pixmap_table/records/brief/height.md#L1: preservepixmapand update the Vale dictionary.snippets/pixmap_table/records/brief/width.md#L1: preservepixmapand update the Vale dictionary.
🧰 Tools
🪛 GitHub Actions: vale / 1_vale.txt
[error] 1-1: [Vale.Spelling] Did you really mean 'pixmap'?
🪛 GitHub Actions: vale / vale
[error] 1-1: Vale.Spelling: Did you really mean 'pixmap'?
🪛 GitHub Check: vale
[failure] 1-1: [vale] snippets/pixmap_table/records/brief/bits_per_pixel.md#L1
[Vale.Spelling] Did you really mean 'pixmap'?
[notice] 1-1: [vale] snippets/pixmap_table/records/brief/bits_per_pixel.md#L1
[Google.Parens] Use parentheses judiciously.
📍 Affects 3 files
snippets/pixmap_table/records/brief/bits_per_pixel.md#L1-L1(this comment)snippets/pixmap_table/records/brief/height.md#L1-L1snippets/pixmap_table/records/brief/width.md#L1-L1
🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
In `@snippets/pixmap_table/records/brief/bits_per_pixel.md` at line 1, Add
“pixmap” to the shared Vale spelling vocabulary while preserving the existing
terminology in snippets/pixmap_table/records/brief/bits_per_pixel.md lines 1-1,
height.md lines 1-1, and width.md lines 1-1; no changes are needed in those
documentation files.
Sources: Linters/SAST tools, Pipeline failures
| **Example 2: With custom advance** (`use_advance_x`) | ||
| Character `W` with a custom 12 pixel advance. |
There was a problem hiding this comment.
📐 Maintainability & Code Quality | 🟡 Minor | ⚡ Quick win
Hyphenate the compound modifier.
Change “12 pixel advance” to “12-pixel advance” to satisfy the documentation grammar check.
🧰 Tools
🪛 GitHub Check: vale
[notice] 71-71: [vale] src/Character Table.md#L71
[Google.Parens] Use parentheses judiciously.
[warning] 71-71: [vale] src/Character Table.md#L71
[Google.Colons] ': W' should be in lowercase.
🪛 LanguageTool
[grammar] ~73-~73: Use a hyphen to join words.
Context: ...nce_x) Character W` with a custom 12 pixel advance. | Byte | Field ...
(QB_NEW_EN_HYPHEN)
🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
In `@src/Character` Table.md around lines 71 - 73, Update the “Example 2: With
custom advance” description for character W to hyphenate the compound modifier
as “12-pixel advance,” preserving the rest of the documentation unchanged.
Source: Pipeline failures
| | Quantity | Formula | | ||
| | --------------------- | -------------------------------------- | | ||
| | `total_bits` | `width × height × bits_per_pixel` | | ||
| | `complete_bytes_used` | `total_bits / 8` | | ||
| | `remainder_bits` | `total_bits % 8` | |
There was a problem hiding this comment.
🗄️ Data Integrity & Integration | 🟠 Major | ⚡ Quick win
Define complete_bytes_used with floor division.
total_bits / 8 yields a fractional value for records such as 15 bits, while the examples require one complete byte plus remainder bits. Specify floor(total_bits / 8) or equivalent integer division to make the serialization contract unambiguous.
🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
In `@src/Pixmap` Table.md around lines 55 - 59, Update the complete_bytes_used
formula in the quantity table to use floor(total_bits / 8), or equivalent
integer division, so partial bytes are excluded while remainder_bits continues
to represent the leftover bits.
There was a problem hiding this comment.
Actionable comments posted: 6
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
Inline comments:
In `@snippets/font_table/records/brief/version.md`:
- Line 1: Update the description in version.md so the line ends with a period
instead of a trailing comma.
In `@snippets/pixmap_table/records/brief/height.md`:
- Line 1: Resolve the Vale spelling failure for “pixmap” in the height
documentation by registering the approved “pixmap”/“Pixmap” terminology in the
project’s Vale vocabulary, or consistently normalizing the wording to an
accepted term. Preserve the documentation’s meaning and ensure the Vale workflow
passes.
In `@src/Font` Table.md:
- Around line 62-63: Rename the example field label from character_tables to
character_table_indexes in the records near the referenced examples, including
all additional occurrences, while leaving the values and descriptions unchanged.
- Line 113: Update the table header in “Font Table.md” by replacing the
ambiguous “Byte(s)” label with the appropriate unambiguous singular or plural
label, such as “Byte” or “Bytes,” while preserving the table structure.
- Line 1: Update the \textinput reference in Font Table.md to use a portable
forward-slash path, replacing the backslash separator while preserving the
existing snippet location and filename.
In `@src/Home.md`:
- Line 1: Update the opening heading in Home.md to remove the trailing
exclamation mark, leaving the rest of the text unchanged so the Vale check
passes.
🪄 Autofix (Beta)
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
ℹ️ Review info
⚙️ Run configuration
Configuration used: defaults
Review profile: CHILL
Plan: Pro Plus
Run ID: aa4e03ce-1752-40d8-961a-230e97d32bbc
📒 Files selected for processing (37)
snippets/character_table/links/brief/pixmap_tables.mdsnippets/character_table/records/brief/code_points.mdsnippets/character_table/records/brief/pixmap_index.mdsnippets/character_table/records/brief/pixmap_table_index.mdsnippets/character_table/records/condition/code_points.mdsnippets/character_table/records/condition/pixmap_index.mdsnippets/character_table/records/condition/pixmap_table_index.mdsnippets/font_table/brief.mdsnippets/font_table/links/brief/character_tables.mdsnippets/font_table/links/condition/character_tables.mdsnippets/font_table/links/flag/link_character_tables.mdsnippets/font_table/records/brief/author.mdsnippets/font_table/records/brief/character_table_indexes.mdsnippets/font_table/records/brief/font_type.mdsnippets/font_table/records/brief/name.mdsnippets/font_table/records/brief/version.mdsnippets/font_table/records/condition/author.mdsnippets/font_table/records/condition/character_table_indexes.mdsnippets/font_table/records/condition/font_type.mdsnippets/font_table/records/condition/name.mdsnippets/font_table/records/condition/version.mdsnippets/pixmap_table/links/brief/color_tables.mdsnippets/pixmap_table/links/condition/color_tables.mdsnippets/pixmap_table/links/flag/link_color_tables.mdsnippets/pixmap_table/records/brief/bits_per_pixel.mdsnippets/pixmap_table/records/brief/data.mdsnippets/pixmap_table/records/brief/height.mdsnippets/pixmap_table/records/brief/width.mdsnippets/pixmap_table/records/condition/bits_per_pixel.mdsnippets/pixmap_table/records/condition/data.mdsnippets/pixmap_table/records/condition/height.mdsnippets/pixmap_table/records/condition/width.mdsrc/Color Table.mdsrc/Font Table.mdsrc/Home.mdsrc/Pixmap Table.mdsrc/Table Architecture.md
🚧 Files skipped from review as they are similar to previous changes (9)
- snippets/pixmap_table/links/flag/link_color_tables.md
- snippets/pixmap_table/links/brief/color_tables.md
- snippets/pixmap_table/records/condition/data.md
- snippets/font_table/records/condition/character_table_indexes.md
- snippets/character_table/records/condition/code_points.md
- snippets/font_table/records/condition/font_type.md
- snippets/pixmap_table/records/brief/data.md
- src/Color Table.md
- src/Pixmap Table.md
| # version | ||
|
|
||
| Write the documentation content for version here. No newline at end of file | ||
| Revision number of this font, No newline at end of file |
There was a problem hiding this comment.
📐 Maintainability & Code Quality | 🟡 Minor | ⚡ Quick win
Remove the trailing comma.
Line 1 should end with a period so the generated description is grammatically complete.
🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
In `@snippets/font_table/records/brief/version.md` at line 1, Update the
description in version.md so the line ends with a period instead of a trailing
comma.
Source: Linters/SAST tools
| # height | ||
|
|
||
| Write the documentation content for height here. No newline at end of file | ||
| Height of this pixmap in pixels. No newline at end of file |
There was a problem hiding this comment.
📐 Maintainability & Code Quality | 🟠 Major | ⚡ Quick win
Resolve the Vale spelling failure for pixmap.
Register the project’s approved pixmap/Pixmap terminology in Vale, or normalize this wording consistently; otherwise the documentation workflow remains red.
🧰 Tools
🪛 GitHub Actions: vale / 1_vale.txt
[error] 1-1: [Vale.Spelling] Did you really mean 'pixmap'?
🪛 GitHub Actions: vale / vale
[error] 1-1: Vale.Spelling: Did you really mean 'pixmap'?
🪛 GitHub Check: vale
[failure] 1-1: [vale] snippets/pixmap_table/records/brief/height.md#L1
[Vale.Spelling] Did you really mean 'pixmap'?
🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
In `@snippets/pixmap_table/records/brief/height.md` at line 1, Resolve the Vale
spelling failure for “pixmap” in the height documentation by registering the
approved “pixmap”/“Pixmap” terminology in the project’s Vale vocabulary, or
consistently normalizing the wording to an accepted term. Preserve the
documentation’s meaning and ensure the Vale workflow passes.
Source: Pipeline failures
1 participant
Summary by CodeRabbit