Skip to content

Adjust string template docs#398

Merged
tjpalmer merged 2 commits intomainfrom
adjust-docs-string-interp
Apr 9, 2026
Merged

Adjust string template docs#398
tjpalmer merged 2 commits intomainfrom
adjust-docs-string-interp

Conversation

@tjpalmer
Copy link
Copy Markdown
Contributor

@tjpalmer tjpalmer commented Mar 27, 2026

  • Also change a tempermd block to tempermd. Here's before:
image

And after:

image
  • This fixes highlighting for the indented code. I still don't address untagged triple-quote in pygments, but this still feels like an improvement overall.
  • Both still have an unclosed string, but that's fixed in Spot-fix to Docs wording #374

tjpalmer added 2 commits March 26, 2026 13:10
@tjpalmer
Claim tempermd; clean interp workarounds
00f0fed 
Signed-off-by: Tom <tom@temper.systems>
@tjpalmer
Structure multiline string docs better
0885ffb 
Signed-off-by: Tom <tom@temper.systems>
tjpalmer
tjpalmer commented Mar 27, 2026
View reviewed changes
Comment thread build-user-docs/skeletal-docs/temper-docs/docs/reference/modules.md
goes inside code blocks:

````md
````tempermd
Copy link
Copy Markdown
Contributor Author

@tjpalmer tjpalmer Mar 27, 2026

Choose a reason for hiding this comment

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

I recognize this in our pygments support, even if I only support indented blocks and not untagged blocks.

Copy link
Copy Markdown
Contributor Author

@tjpalmer tjpalmer Mar 27, 2026

Choose a reason for hiding this comment

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

I'm unsure how well I cope with breaking blocks in the middle of string interpolation values or other edge cases. Maybe something to keep in mind in the future.

Comment thread build-user-docs/skeletal-docs/temper-docs/docs/tutorial/05-builtin.md

Triple-quotes like `"""` start a multiline string, then all whitespace and
comments are ignored, and every line content beginning with any of the following
continues the string:
Copy link
Copy Markdown
Contributor Author

@tjpalmer tjpalmer Mar 27, 2026

Choose a reason for hiding this comment

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

Realized I'd somehow left out intro text for the next example. I think this current arrangement now still isn't ideal, but I think it's an improvement.

Comment thread build-user-docs/skeletal-docs/temper-docs/docs/tutorial/05-builtin.md
// Use empty interpolation to provide trailing whitespace.
~${i.toString()}, ${""}
~${i}, ${}
:}
Copy link
Copy Markdown
Contributor Author

@tjpalmer tjpalmer Mar 27, 2026

Choose a reason for hiding this comment

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

Changed this because #392 is merged.

Copy link
Copy Markdown
Contributor Author

@tjpalmer tjpalmer Mar 31, 2026

Choose a reason for hiding this comment

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

But also waiting on #399 now.

@tjpalmer tjpalmer marked this pull request as ready for review March 27, 2026 20:32
@tjpalmer tjpalmer mentioned this pull request Mar 31, 2026
Merged
@tjpalmer tjpalmer marked this pull request as draft April 3, 2026 16:28
@tjpalmer
Copy link
Copy Markdown
Contributor Author

tjpalmer commented Apr 3, 2026

I reverted this to a draft for now until #399 goes in.

@tjpalmer tjpalmer marked this pull request as ready for review April 9, 2026 15:42
@tjpalmer tjpalmer merged commit c099a0b into main Apr 9, 2026
2 checks passed
@tjpalmer tjpalmer deleted the adjust-docs-string-interp branch April 9, 2026 15:42
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@mikesamuel mikesamuel mikesamuel approved these changes

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

2 participants

@tjpalmer @mikesamuel