Skip to content

fix: restore the em-dash example in the no-em-dash STYLEGUIDE rule#398

Merged
0xNeshi merged 1 commit into
mainfrom
fix/styleguide-emdash-rule
Jun 18, 2026
Merged

fix: restore the em-dash example in the no-em-dash STYLEGUIDE rule#398
0xNeshi merged 1 commit into
mainfrom
fix/styleguide-emdash-rule

Conversation

@bidzyyys

@bidzyyys bidzyyys commented Jun 17, 2026

Copy link
Copy Markdown
Collaborator

PR #388's repo-wide em-dash → - replace also hit the literal em-dash this rule uses as its example, leaving the nonsensical "use - instead of em dashes (-)". Restore the example character.

This one line is the single intentional in the repo (the rule has to show the character it tells you to avoid).

🤖 Generated with Claude Code

Summary by CodeRabbit

  • Documentation
    • Updated style guidelines to standardize punctuation conventions for contributed content.

PR #388's repo-wide em-dash replace also hit the literal em-dash this rule uses as its example, leaving "use `-` instead of em dashes (`-`)". Restore the example char; this is the single intentional em-dash in the repo.
@coderabbitai

coderabbitai Bot commented Jun 17, 2026

Copy link
Copy Markdown

Review Change Stack

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Pro

Run ID: a10b7cc6-48ec-4a64-a4e2-df20b6c67526

📥 Commits

Reviewing files that changed from the base of the PR and between a21d7bb and d04710c.

📒 Files selected for processing (1)
  • STYLEGUIDE.md

📝 Walkthrough

Walkthrough

The STYLEGUIDE.md Documentation section bullet about avoiding em dashes is updated to display the actual em dash character () as the example to avoid, while keeping the regular hyphen (-) as the recommended replacement.

Changes

Style guide em dash punctuation fix

Layer / File(s) Summary
Em dash avoidance bullet correction
STYLEGUIDE.md
The bullet instructing contributors to avoid em dashes now uses the literal character in its example, correcting the prior text that did not show the actual em dash glyph.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~1 minutes

Poem

A dash is a dash, but an em dash is wide,
🐇 the rabbit corrected what hid inside—
now stands clear where it ought to be seen,
replaced by a hyphen, tidy and clean.
One character changed, the guide rings true!

🚥 Pre-merge checks | ✅ 4 | ❌ 1

❌ Failed checks (1 inconclusive)

Check name Status Explanation Resolution
Description check ❓ Inconclusive The description clearly explains the issue and fix. However, it lacks required template sections like issue reference and checklist items. Add 'Resolves #XXX' section and complete the PR Checklist with appropriate items marked. Include context about the unintended consequence of PR #388.
✅ Passed checks (4 passed)
Check name Status Explanation
Title check ✅ Passed The title accurately describes the main change: restoring an em-dash example in the no-em-dash style guide rule that was accidentally replaced.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch fix/styleguide-emdash-rule

Comment @coderabbitai help to get the list of available commands and usage tips.

@codecov

codecov Bot commented Jun 17, 2026

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 78.90%. Comparing base (a21d7bb) to head (d04710c).

Additional details and impacted files
@@           Coverage Diff           @@
##             main     #398   +/-   ##
=======================================
  Coverage   78.90%   78.90%           
=======================================
  Files          23       23           
  Lines        1782     1782           
  Branches      640      641    +1     
=======================================
  Hits         1406     1406           
  Misses        341      341           
  Partials       35       35           
Flag Coverage Δ
contracts/access 65.40% <ø> (ø)
contracts/utils 44.09% <ø> (ø)
math/fixed_point 56.59% <ø> (ø)

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Harness.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

@ericnordelo ericnordelo left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

LGTM!

@0xNeshi 0xNeshi merged commit d0fd11a into main Jun 18, 2026
17 of 18 checks passed
@0xNeshi 0xNeshi deleted the fix/styleguide-emdash-rule branch June 18, 2026 08:42
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants