chore: normalize marks inside Markdown code-block comments#45
Merged
Conversation
Completes the devflow mark sweep (#43, #44). #43 preserved fenced code blocks verbatim; this converts the em-dash / arrow / ellipsis marks in their `#` comment/annotation portions only - never command text (every changed line is a shell comment). 41 marks across 9 docs. `references/cheatsheet.md` is embedded in `solx cheatsheet`, so its output now shows `->` in those annotations. The committed `docs/cheatsheet.pdf` is unaffected: only arrows changed there, and `build-cheatsheet.sh` already rewrites the arrow to `->` for the PDF. Docs only, no version bump. `cargo test` 104+40 green (incl. the cheatsheet needle test). Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
Contributor
There was a problem hiding this comment.
Pull request overview
This PR completes the “devflow mark sweep” by normalizing remaining Unicode punctuation (—/→/…) that appears inside Markdown fenced code blocks, but only within the # comment/annotation portions (leaving command text untouched).
Changes:
- Convert
→to->in fenced-block comment annotations. - Convert
—to-in fenced-block comment annotations. - Convert
…to...in fenced-block comment annotations.
Reviewed changes
Copilot reviewed 9 out of 9 changed files in this pull request and generated 1 comment.
Show a summary per file
| File | Description |
|---|---|
| skills/sol-skill/SKILL.md | Normalizes punctuation inside fenced shell-block comment/annotation text. |
| skills/sol-skill/references/solx.md | Normalizes punctuation in fenced examples and inline annotations. |
| skills/sol-skill/references/slurm.md | Normalizes punctuation in fenced examples’ inline comment text. |
| skills/sol-skill/references/sessions.md | Normalizes punctuation in fenced examples’ comment/annotation lines. |
| skills/sol-skill/references/cheatsheet.md | Normalizes punctuation in fenced examples’ comment/annotation lines (cheatsheet source). |
| evals/README.md | Normalizes punctuation in layout/example blocks and inline annotations. |
| docs/solx.md | Normalizes punctuation in fenced examples’ comment/annotation lines. |
| docs/scratch.md | Normalizes punctuation in fenced examples’ comment/annotation lines. |
| DEVELOPMENT.md | Normalizes punctuation in repo layout block and mock-usage example annotation. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Comment on lines
204
to
+206
| sacctmgr -n show assoc user=$USER format=Account,Partition,QOS | ||
| # → e.g. grp_yourpi || debug,htc,private,public | ||
| myfairshare # dampened RealFairShare; low → prefer a buy-in/preemptible QOS (raw `sshare -U` is undampened) | ||
| # -> e.g. grp_yourpi || debug,htc,private,public | ||
| myfairshare # dampened RealFairShare; low -> prefer a buy-in/preemptible QOS (raw `sshare -U` is undampened) |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Completes the devflow mark sweep. #43 preserved fenced code blocks verbatim (to avoid touching command examples and
solx cheatsheetoutput); this converts the—/→/…marks in their#comment/annotation portions only — never command text. Every changed line is a shell comment (verified: no changed line lacks a#). 41 marks across 9 docs.Safety
#on a fenced-block line is converted.cheatsheet.mdis embedded insolx cheatsheet, so its output now shows->in those annotations (matching the rest of the docs). The committeddocs/cheatsheet.pdfis unaffected: only arrows changed there, andbuild-cheatsheet.shalready rewrites the arrow to->when building the PDF (no em-dash/ellipsis changed in that file).cheatsheet.rsneedle test unaffected (needles are plain words).Not a release
Docs-only cosmetic change, no version bump. Ships with the next tagged release.
Verification
cargo test104 + 40 pass (incl.cheatsheet_has_the_key_sections) · a repo-wide scan confirms 0 marks remain in any Markdown file.🤖 Generated with Claude Code