Add i.e./e.g. comma and bold-colon style rules to doc-update skill. - #36
Open
smagee-robot wants to merge 2 commits into
Open
Add i.e./e.g. comma and bold-colon style rules to doc-update skill.#36smagee-robot wants to merge 2 commits into
smagee-robot wants to merge 2 commits into
Conversation
Clarify that non-code i.e./e.g. require trailing commas and that colons belong outside bold spans in description lists and callouts. Co-authored-by: Cursor <cursoragent@cursor.com>
Contributor
There was a problem hiding this comment.
Pull request overview
Updates the datarobot-app-framework-doc-update skill’s documentation style guidance to standardize two punctuation conventions used during README merges: (1) trailing commas after non-code i.e./e.g. and (2) placing colons outside bold labels in description lists and GitHub-style callouts.
Changes:
- Add guidance + examples requiring
e.g.,/i.e.,in non-code prose (with an exception for code/literals). - Add guidance + examples requiring colons outside bold spans (e.g.,
> **Note**: …). - Update the style spec checklist, verification steps, and change logs to reflect these rules.
Reviewed changes
Copilot reviewed 6 out of 6 changed files in this pull request and generated 1 comment.
Show a summary per file
| File | Description |
|---|---|
| skills/datarobot-app-framework-doc-update/SKILL.md | Updates an example to use e.g., for consistency with the new rule. |
| skills/datarobot-app-framework-doc-update/references/technical-documentation.md | Adds a preferred/avoid table illustrating “colon outside bold span” usage. |
| skills/datarobot-app-framework-doc-update/references/grammar-and-punctuation.md | Adds a rule + examples requiring commas after non-code i.e./e.g.. |
| skills/datarobot-app-framework-doc-update/references/github-markdown-authoring.md | Updates callout examples to > **Note**: … style (colon outside bold). |
| skills/datarobot-app-framework-doc-update/references/document-history.md | Logs the new punctuation rules in the style guide history. |
| skills/datarobot-app-framework-doc-update/documentation-style-spec.md | Adds the new rules to the quick reference + checklist and logs them in version history. |
💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.
Co-authored-by: Copilot Autofix powered by AI <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.
Clarify that non-code i.e./e.g. require trailing commas and that colons belong outside bold spans in description lists and callouts.
Summary
Rationale
Changes
Note
Low Risk
Documentation-only updates to internal style guides; no application code, auth, or data handling.
Overview
Extends the datarobot-app-framework-doc-update style spec so README merges follow two punctuation conventions: non-code i.e./e.g. must use a trailing comma, and colons sit outside bold labels in description lists and GitHub callouts (e.g.,
> **Note**:not> **Note:**).The quick reference, README checklist, and verification steps in
documentation-style-spec.mdare updated accordingly;grammar-and-punctuation.md,technical-documentation.md, andgithub-markdown-authoring.mdadd preferred/avoid examples;document-history.mdand the spec version table log the change.SKILL.mdonly adjusts an example toe.g.,for consistency.Reviewed by Cursor Bugbot for commit ae27e88. Configure here.