Open
Conversation
Contributor
There was a problem hiding this comment.
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.
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
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.
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