-
Notifications
You must be signed in to change notification settings - Fork 0
Update Specifications #4
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
base: main
Are you sure you want to change the base?
Changes from all commits
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1 @@ | ||
| The exact codepoint length of each `code_points` field in this table | ||
|
Check failure on line 1 in snippets/character_table/configurations/brief/constant_code_point_count.md
|
||
|
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Resolve Vale spelling failure ( CI is failing on this line. Replace 🧰 Tools🪛 GitHub Actions: vale / vale[error] 1-1: [Vale.Spelling] Did you really mean 'codepoint'? 🪛 GitHub Check: vale[failure] 1-1: [vale] snippets/character_table/configurations/brief/constant_code_point_count.md#L1 🤖 Prompt for AI Agents |
||
This file was deleted.
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1 @@ | ||
| If `use_constant_code_point_count` is enabled. | ||
|
Check warning on line 1 in snippets/character_table/configurations/condition/constant_code_point_count.md
|
||
This file was deleted.
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1 @@ | ||
| All characters in this table have the same number of code points. |
This file was deleted.
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1 +1 @@ | ||
| UTF-8 encoded codepoint sequence (null-terminated unless `constant_codepoint_count` is set). | ||
| UTF-8 encoded codepoint sequence (null-terminated unless `constant_code_point_count` is set). | ||
|
Check notice on line 1 in snippets/character_table/records/condition/code_points.md
|
||
|
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Fix CI-blocking spelling in Vale fails on 🧰 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 [failure] 1-1: [vale] snippets/character_table/records/condition/code_points.md#L1 [notice] 1-1: [vale] snippets/character_table/records/condition/code_points.md#L1 [notice] 1-1: [vale] snippets/character_table/records/condition/code_points.md#L1 [warning] 1-1: [vale] snippets/character_table/records/condition/code_points.md#L1 🤖 Prompt for AI Agents |
||
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,3 +1,6 @@ | ||
| # color_table table | ||
| Stores RGBA color values that can be referenced by pixmap data. | ||
|
Check notice on line 1 in snippets/color_table/brief.md
|
||
|
|
||
| Write the documentation content for color_table table here. | ||
| ## Use Cases | ||
|
Check warning on line 3 in snippets/color_table/brief.md
|
||
|
|
||
| - **Pixmap palettes** - When linked to a Pixmap Table, provides the color palette for indexed pixel data. | ||
|
Check failure on line 5 in snippets/color_table/brief.md
|
||
| - **Color storage** - Can store color sets independently for other purposes. | ||
|
Comment on lines
+1
to
+6
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Address Vale spelling failures for 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 [warning] 1-1: [vale] snippets/color_table/brief.md#L1 [notice] 1-1: [vale] snippets/color_table/brief.md#L1 [notice] 1-1: [vale] snippets/color_table/brief.md#L1 [failure] 1-1: [vale] snippets/color_table/brief.md#L1 [warning] 3-3: [vale] snippets/color_table/brief.md#L3 [failure] 5-5: [vale] snippets/color_table/brief.md#L5 [failure] 5-5: [vale] snippets/color_table/brief.md#L5 🤖 Prompt for AI Agents |
||
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,3 +0,0 @@ | ||
| # constant_alpha | ||
|
|
||
| Write the documentation content for constant_alpha here. | ||
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,3 @@ | ||
| # alpha | ||
|
Check warning on line 1 in snippets/color_table/records/condition/alpha.md
|
||
|
|
||
| Write the documentation content for alpha here. | ||
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,3 @@ | ||
| # blue | ||
|
Check warning on line 1 in snippets/color_table/records/condition/blue.md
|
||
|
|
||
| Write the documentation content for blue here. | ||
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,3 @@ | ||
| # color_type | ||
|
Check failure on line 1 in snippets/color_table/records/condition/color_type.md
|
||
|
|
||
| Write the documentation content for color_type here. | ||
|
Check failure on line 3 in snippets/color_table/records/condition/color_type.md
|
||
|
Comment on lines
+1
to
+3
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Replace underscore identifier prose to pass Vale ( This file fails lint on 🧰 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 [warning] 1-1: [vale] snippets/color_table/records/condition/color_type.md#L1 [failure] 3-3: [vale] snippets/color_table/records/condition/color_type.md#L3 🤖 Prompt for AI Agents |
||
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,3 @@ | ||
| # green | ||
|
Check warning on line 1 in snippets/color_table/records/condition/green.md
|
||
|
|
||
| Write the documentation content for green here. | ||
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,3 @@ | ||
| # red | ||
|
Check warning on line 1 in snippets/color_table/records/condition/red.md
|
||
|
|
||
| Write the documentation content for red here. | ||
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,3 @@ | ||
| # author | ||
|
Check warning on line 1 in snippets/font_table/records/condition/author.md
|
||
|
|
||
| Write the documentation content for author here. | ||
| Original file line number | Diff line number | Diff line change | ||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| @@ -0,0 +1,3 @@ | ||||||||||||||
| # character_table_indexes | ||||||||||||||
|
Check failure on line 1 in snippets/font_table/records/condition/character_table_indexes.md
|
||||||||||||||
|
|
||||||||||||||
| Write the documentation content for character_table_indexes here. | ||||||||||||||
|
Check failure on line 3 in snippets/font_table/records/condition/character_table_indexes.md
|
||||||||||||||
|
Comment on lines
+1
to
+3
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Fix Vale spelling failures in heading/body token usage (Line 1, Line 3).
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
Suggested change
🧰 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 [warning] 1-1: [vale] snippets/font_table/records/condition/character_table_indexes.md#L1 🤖 Prompt for AI Agents |
||||||||||||||
| Original file line number | Diff line number | Diff line change | ||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| @@ -0,0 +1,3 @@ | ||||||||||||||
| # font_type | ||||||||||||||
|
Check failure on line 1 in snippets/font_table/records/condition/font_type.md
|
||||||||||||||
|
|
||||||||||||||
| Write the documentation content for font_type here. | ||||||||||||||
|
Check failure on line 3 in snippets/font_table/records/condition/font_type.md
|
||||||||||||||
|
Comment on lines
+1
to
+3
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Resolve CI-breaking spelling errors for 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
Suggested change
🧰 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 [warning] 1-1: [vale] snippets/font_table/records/condition/font_type.md#L1 [failure] 3-3: [vale] snippets/font_table/records/condition/font_type.md#L3 🤖 Prompt for AI Agents |
||||||||||||||
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,3 @@ | ||
| # name | ||
|
Check warning on line 1 in snippets/font_table/records/condition/name.md
|
||
|
|
||
| Write the documentation content for name here. | ||
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,3 @@ | ||
| # version | ||
|
Check warning on line 1 in snippets/font_table/records/condition/version.md
|
||
|
|
||
| Write the documentation content for version here. | ||
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,3 @@ | ||
| # constant_bits_per_pixel | ||
|
Check failure on line 1 in snippets/pixmap_table/configurations/condition/constant_bits_per_pixel.md
|
||
|
|
||
| Write the documentation content for constant_bits_per_pixel here. | ||
|
Check failure on line 3 in snippets/pixmap_table/configurations/condition/constant_bits_per_pixel.md
|
||
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,3 @@ | ||
| # constant_height | ||
|
Check failure on line 1 in snippets/pixmap_table/configurations/condition/constant_height.md
|
||
|
|
||
| Write the documentation content for constant_height here. | ||
|
Check failure on line 3 in snippets/pixmap_table/configurations/condition/constant_height.md
|
||
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,3 @@ | ||
| # constant_width | ||
|
Check failure on line 1 in snippets/pixmap_table/configurations/condition/constant_width.md
|
||
|
|
||
| Write the documentation content for constant_width here. | ||
|
Check failure on line 3 in snippets/pixmap_table/configurations/condition/constant_width.md
|
||
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,3 @@ | ||
| # constant_bits_per_pixel | ||
|
Check failure on line 1 in snippets/pixmap_table/configurations/flag/use_constant_bits_per_pixel.md
|
||
|
|
||
| Write the documentation content for constant_bits_per_pixel here. | ||
|
Check failure on line 3 in snippets/pixmap_table/configurations/flag/use_constant_bits_per_pixel.md
|
||
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,3 @@ | ||
| # constant_height | ||
|
Check warning on line 1 in snippets/pixmap_table/configurations/flag/use_constant_height.md
|
||
|
|
||
| Write the documentation content for constant_height here. | ||
|
Check failure on line 3 in snippets/pixmap_table/configurations/flag/use_constant_height.md
|
||
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,3 @@ | ||
| # constant_width | ||
|
Check failure on line 1 in snippets/pixmap_table/configurations/flag/use_constant_width.md
|
||
|
|
||
| Write the documentation content for constant_width here. | ||
|
Check failure on line 3 in snippets/pixmap_table/configurations/flag/use_constant_width.md
|
||
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,3 @@ | ||
| # bits_per_pixel | ||
|
Check failure on line 1 in snippets/pixmap_table/records/condition/bits_per_pixel.md
|
||
|
|
||
| Write the documentation content for bits_per_pixel here. | ||
|
Check failure on line 3 in snippets/pixmap_table/records/condition/bits_per_pixel.md
|
||
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,3 @@ | ||
| # data | ||
|
Check warning on line 1 in snippets/pixmap_table/records/condition/data.md
|
||
|
|
||
| Write the documentation content for data here. | ||
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,3 @@ | ||
| # height | ||
|
Check warning on line 1 in snippets/pixmap_table/records/condition/height.md
|
||
|
|
||
| Write the documentation content for height here. | ||
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,3 @@ | ||
| # width | ||
|
Check warning on line 1 in snippets/pixmap_table/records/condition/width.md
|
||
|
|
||
| Write the documentation content for width here. | ||
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -24,14 +24,14 @@ | |
|
|
||
| | Bit | Name | Description | | ||
| | --- | ------------------------------ | --------------------------------------------------------------- | | ||
| | 0 | `use_constant_codepoint_count` | \textinput{../snippets/character_table/configurations/flag/use_constant_codepoint_count.md} | | ||
| | 0 | `use_constant_code_point_count` | \textinput{../snippets/character_table/configurations/flag/use_constant_code_point_count.md} | | ||
| | 1-7 | — | \textinput{../snippets/phrase/reserved.md} | | ||
|
|
||
| #### Configuration Values | ||
|
|
||
| | Name | Type | Condition | Description | | ||
| | -------------------------- | ---- | -------------------------------------------- | ------------------------------------------------------------------- | | ||
| | `constant_codepoint_count` | `u8` | \textinput{../snippets/character_table/configurations/condition/constant_codepoint_count.md} | \textinput{../snippets/character_table/configurations/brief/constant_codepoint_count.md} | | ||
| | `constant_code_point_count` | `u8` | \textinput{../snippets/character_table/configurations/condition/constant_code_point_count.md} | \textinput{../snippets/character_table/configurations/brief/constant_code_point_count.md} | | ||
|
|
||
| ### Table Links | ||
|
|
||
|
|
@@ -54,8 +54,8 @@ Each character record contains the following fields in order: | |
| | -------------------- | -------------------- | ----------------------------------------------- | ------------------------------------------------------------------------------------------- | | ||
| | `advance_x` | `u8` | \textinput{../snippets/character_table/records/condition/advance_x.md} | \textinput{../snippets/character_table/records/brief/advance_x.md} | | ||
| | `pixmap_index` | `u8` | \textinput{../snippets/character_table/records/condition/pixmap_index.md} | \textinput{../snippets/character_table/records/brief/pixmap_index.md} | | ||
| | `pixmap_table_index` | `Index<PixmapTable>` | \textinput{../snippets/character_table/records/condition/pixmap_table_index.md} | \textinput{../snippets/character_table/records/brief/pixmap_table_index.md} | | ||
| | `codepoints` | `str` | \textinput{../snippets/character_table/records/condition/codepoints.md} | \textinput{../snippets/character_table/records/brief/codepoints.md} | | ||
| | `pixmap_table_index` | `u8` | \textinput{../snippets/character_table/records/condition/pixmap_table_index.md} | \textinput{../snippets/character_table/records/brief/pixmap_table_index.md} | | ||
| | `code_points` | `String` | \textinput{../snippets/character_table/records/condition/code_points.md} | \textinput{../snippets/character_table/records/brief/codepoints.md} | | ||
|
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. 🧩 Analysis chain🏁 Script executed: #!/bin/bash
# Verify both possible brief snippet filenames and all references.
fd -i 'code_points.md|codepoints.md' snippets/character_table/records/brief snippets/character_table/records/condition
rg -n 'records/(brief|condition)/(code_points|codepoints)\.md' src snippetsRepository: SimplePixelFont/Specification Length of output: 408 🏁 Script executed: #!/bin/bash
set -euo pipefail
# Confirm whether the mistakenly referenced file exists anywhere.
echo "== Files named codepoints.md under character_table snippets =="
fd -i 'codepoints\.md$' snippets/character_table/records/brief snippets/character_table/records/condition snippets/character_table/records || true
echo "== Any codepoints.md references in src =="
rg -n 'snippets/character_table/records/brief/codepoints\.md' src || true
echo "== Any codepoints.md filename references in src/snippets =="
rg -n 'codepoints\.md' src snippets || trueRepository: SimplePixelFont/Specification Length of output: 684 Fix snippet include path mismatch for
| `code_points` | `String` | \textinput{../snippets/character_table/records/condition/code_points.md} | \textinput{../snippets/character_table/records/brief/codepoints.md} |🤖 Prompt for AI Agents |
||
|
|
||
| ### Record Layout Examples | ||
|
|
||
|
|
||
| Original file line number | Diff line number | Diff line change | ||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| @@ -0,0 +1,70 @@ | ||||||||||||||||||
| \textinput{../snippets/color_table/brief.md} | ||||||||||||||||||
|
|
||||||||||||||||||
| ## Table Structure | ||||||||||||||||||
|
Check warning on line 3 in src/Color Table.md
|
||||||||||||||||||
|
|
||||||||||||||||||
| ### Identifier | ||||||||||||||||||
| - **Value**: `0x03` | ||||||||||||||||||
|
|
||||||||||||||||||
|
|
||||||||||||||||||
| ## Modifier Flags | ||||||||||||||||||
|
Check warning on line 9 in src/Color Table.md
|
||||||||||||||||||
|
|
||||||||||||||||||
| | Bit | Name | Description | | ||||||||||||||||||
| | --- | ---- | ----------- | | ||||||||||||||||||
| | 0 | `use_color_type` | \textinput{../snippets/color_table/modifiers/brief/use_color_type.md} | | ||||||||||||||||||
| | 1-7 | — | \textinput{../snippets/phrase/reserved.md} | | ||||||||||||||||||
|
|
||||||||||||||||||
| ### Flag Details | ||||||||||||||||||
|
Check warning on line 16 in src/Color Table.md
|
||||||||||||||||||
|
|
||||||||||||||||||
| - **`use_color_type`**: \textinput{../snippets/color_table/modifiers/details/use_color_type.md} | ||||||||||||||||||
|
|
||||||||||||||||||
| ## Configuration Flags | ||||||||||||||||||
|
Check warning on line 20 in src/Color Table.md
|
||||||||||||||||||
|
|
||||||||||||||||||
| | Bit | Name | Description | | ||||||||||||||||||
| | --- | ---- | ----------- | | ||||||||||||||||||
| | 0 | `use_constant_alpha` | \textinput{../snippets/color_table/configurations/flag/use_constant_alpha.md} | | ||||||||||||||||||
| | 1-7 | — | \textinput{../snippets/phrase/reserved.md} | | ||||||||||||||||||
|
|
||||||||||||||||||
| ### Configuration Values | ||||||||||||||||||
|
Check warning on line 27 in src/Color Table.md
|
||||||||||||||||||
|
|
||||||||||||||||||
| | Name | Type | Condition | Description | | ||||||||||||||||||
| | ---- | ---- | --------- | ----------- | | ||||||||||||||||||
| | `constant_alpha` | `u8` | \textinput{../snippets/color_table/configurations/condition/constant_alpha.md} | \textinput{../snippets/color_table/configurations/brief/constant_alpha.md} | | ||||||||||||||||||
|
|
||||||||||||||||||
| ## Record Fields | ||||||||||||||||||
|
Check warning on line 33 in src/Color Table.md
|
||||||||||||||||||
|
|
||||||||||||||||||
|
|
||||||||||||||||||
| Each record contains the following fields in order: | ||||||||||||||||||
|
|
||||||||||||||||||
| | Field | Type | Condition | Description | | ||||||||||||||||||
| | ----- | ---- | --------- | ----------- | | ||||||||||||||||||
| | `color_type` | `[TYPE_PLACEHOLDER]` | \textinput{../snippets/color_table/records/condition/color_type.md} | \textinput{../snippets/color_table/records/brief/color_type.md} | | ||||||||||||||||||
| | `alpha` | `[TYPE_PLACEHOLDER]` | \textinput{../snippets/color_table/records/condition/alpha.md} | \textinput{../snippets/color_table/records/brief/alpha.md} | | ||||||||||||||||||
| | `red` | `[TYPE_PLACEHOLDER]` | \textinput{../snippets/color_table/records/condition/red.md} | \textinput{../snippets/color_table/records/brief/red.md} | | ||||||||||||||||||
| | `green` | `[TYPE_PLACEHOLDER]` | \textinput{../snippets/color_table/records/condition/green.md} | \textinput{../snippets/color_table/records/brief/green.md} | | ||||||||||||||||||
| | `blue` | `[TYPE_PLACEHOLDER]` | \textinput{../snippets/color_table/records/condition/blue.md} | \textinput{../snippets/color_table/records/brief/blue.md} | | ||||||||||||||||||
|
|
||||||||||||||||||
| ## Examples | ||||||||||||||||||
|
|
||||||||||||||||||
|
|
||||||||||||||||||
| Provide example records demonstrating various field combinations: | ||||||||||||||||||
|
Check warning on line 49 in src/Color Table.md
|
||||||||||||||||||
|
|
||||||||||||||||||
| **Example 1: Minimal record** (no optional fields) | ||||||||||||||||||
|
Check warning on line 51 in src/Color Table.md
|
||||||||||||||||||
| ``` | ||||||||||||||||||
| [EXAMPLE_PLACEHOLDER] | ||||||||||||||||||
| ``` | ||||||||||||||||||
|
|
||||||||||||||||||
| **Example 2: With optional fields** | ||||||||||||||||||
|
Check warning on line 56 in src/Color Table.md
|
||||||||||||||||||
| ``` | ||||||||||||||||||
| [EXAMPLE_PLACEHOLDER] | ||||||||||||||||||
|
Comment on lines
+52
to
+58
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. 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]... 🧰 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 |
||||||||||||||||||
| ``` | ||||||||||||||||||
|
|
||||||||||||||||||
|
|
||||||||||||||||||
| ## Complete Table Example | ||||||||||||||||||
|
Check warning on line 62 in src/Color Table.md
|
||||||||||||||||||
|
|
||||||||||||||||||
|
|
||||||||||||||||||
| The following byte sequence defines a minimal table with example records: | ||||||||||||||||||
|
|
||||||||||||||||||
| | Byte(s) | Binary | Hex | Description | | ||||||||||||||||||
|
Check failure on line 67 in src/Color Table.md
|
||||||||||||||||||
| | ------- | ------ | --- | ----------- | | ||||||||||||||||||
| | 1 | `[BINARY_PLACEHOLDER]` | `[HEX_PLACEHOLDER]` | Table identifier | | ||||||||||||||||||
| | ... | ... | ... | [DESCRIPTION_PLACEHOLDER] | | ||||||||||||||||||
|
Check warning on line 70 in src/Color Table.md
|
||||||||||||||||||
|
Comment on lines
+67
to
+70
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Fix Vale failures in the table example header/text (Line 67, Line 70). Current wording is failing CI: Suggested patch-| Byte(s) | Binary | Hex | Description |
+| Bytes | Binary | Hex | Description |
...
-| ... | ... | ... | [DESCRIPTION_PLACEHOLDER] |
+| … | … | … | [DESCRIPTION_PLACEHOLDER] |📝 Committable suggestion
Suggested change
🧰 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 |
||||||||||||||||||
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Fix link-flag snippet path contract mismatch.
generateStructurenow createslinks/flag/link_<name>.md, but the document builder still reads link flag descriptions fromlinks/condition. This leaves newlinks/flagfiles unused and can generate broken references.Suggested fix
🤖 Prompt for AI Agents