Coerce copilot to avoid emdash everywhere

[adegeo]

Summary

Copilot used the agent to write some docs and I noticed it was heavily relying on emdash everywhere which doesn't make for good reading. These instructions seemed to have helped it avoid it.

---

Internal previews

📄 File	🔗 Preview link
.github/agents/docseditor.agent.md	Article Writing and Editing Instructions for LLMs

[Copilot]

Pull request overview

Updates the docs editor agent instructions to reduce overuse of em dashes in generated/edited documentation, aiming for improved readability and consistency with the repo’s writing style guidance.

Changes:

• Adds guidance to avoid em dashes and related dash characters where possible.
• Clarifies that hyphens in compound adjectives are acceptable.
• Allows limited/emphasized use of em dashes mid-sentence.

[Copilot]

The new guidance on em dashes conflicts with the existing mandatory rule immediately above it. You currently say to "ALWAYS use no spaces around dashes" (with an em dash example), then "TRY to avoid" em dashes, then "OK to use" em dashes. Please consolidate/reword so the rules are consistent (for example: avoid em dashes where possible; if you must use an em dash, don’t include spaces around it; hyphens in compound modifiers are fine). Also consider naming the specific dash characters (em dash vs en dash) so the instruction is unambiguous.

Suggested change

	- ALWAYS use no spaces around dashes: "Use pipelines—logical groups—to consolidate"
	- ALWAYS add blank lines around markdown elements (don't add extra if they exist)
	- TRY to avoid emdash and the various alternative dash characters; try to use other punctuation or formatting to achieve the same effect. Choose words over characters when possible
	- OK to use compound adjectives with hyphens
	- OK to use emdash mid-sentence for a clause or example; use sparingly
	- ALWAYS add blank lines around markdown elements (don't add extra if they exist)
	- TRY to avoid em dashes (—) where possible; prefer other punctuation, formatting, or clearer wording
	- If you must use an em dash (—), use no spaces around it: "Use pipelines—logical groups—to consolidate"
	- OK to use hyphens (-) in compound adjectives

[Copilot]

"emdash" should be written as "em dash" (and it may help to include the glyph "—" the first time for clarity).

Suggested change

	- TRY to avoid emdash and the various alternative dash characters; try to use other punctuation or formatting to achieve the same effect. Choose words over characters when possible
	- OK to use compound adjectives with hyphens
	- OK to use emdash mid-sentence for a clause or example; use sparingly
	- TRY to avoid em dash and the various alternative dash characters; try to use other punctuation or formatting to achieve the same effect. Choose words over characters when possible
	- OK to use compound adjectives with hyphens
	- OK to use an em dash (—) mid-sentence for a clause or example; use sparingly

[BillWagner]

Thank you!