Skip to content

Docs: list the CharProps and ParaProps fields (#865) - #899

Merged
echelon merged 3 commits into
storytold:mainfrom
marcoarnulfo:docs/char-para-props
Oct 12, 2026
Merged

echelon merged 3 commits into
storytold:mainfrom
marcoarnulfo:docs/char-para-props

Conversation

@marcoarnulfo

Copy link
Copy Markdown
Contributor

Part of #865: the docs half (#881 is the colour half; together they cover the issue).

docs/mcp.md gets a "Character and paragraph properties" section listing every field of CharProps and ParaProps as format.set, para.set, styles.modify and the table style commands take them: the JSON name, its type, and the accepted values for the enums, lineSpacing, numbering, tabs and borders. It also says that an unknown field is ignored rather than refused, which is what makes a misspelt name hard to spot. docs/control-protocol.md links to it. The color row describes what main accepts today ("Auto" or {"Rgb": [r, g, b]}); whichever of this and #881 lands second can add the hex form to that line.

Validation:

  • Checked each field against crates/doc/src/props.rs (serde renames, autoSpaceDE/autoSpaceDN, inside_v in Borders, the tagged lineSpacing).
  • A throwaway test (not committed) round-tripped a CharProps and a ParaProps with every documented field, plus every listed enum value, through serde; a misspelt field name made it fail.

@echelon
echelon merged commit b9899f4 into storytold:main Oct 12, 2026
@echelon

echelon commented Oct 12, 2026

Copy link
Copy Markdown
Member

Thanks for the contribution, @marcoarnulfo! This is now merged into main. If you haven't already, please come join us on Discord: https://discord.gg/artcraft

rbr48 pushed a commit to rbr48/wordcraft that referenced this pull request Oct 13, 2026
…old#899)

* Docs: list the CharProps and ParaProps fields (storytold#865)

* docs/mcp.md: color also takes RRGGBB and #RRGGBB (storytold#865, storytold#881)

---------

Co-authored-by: Brandon Thomas <echelon@gmail.com>
(cherry picked from commit b9899f4)
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