Skip to content

docs(i18n): use the reference's dash typography in the Italian index and titles - #97

Merged
FROWNINGdev merged 12 commits into
mainfrom
docs/it-dash-typography
Sep 2, 2026
Merged

docs(i18n): use the reference's dash typography in the Italian index and titles#97
FROWNINGdev merged 12 commits into
mainfrom
docs/it-dash-typography

Conversation

@FROWNINGdev

@FROWNINGdev FROWNINGdev commented Sep 2, 2026

Copy link
Copy Markdown
Owner

Follow-up to #95, cosmetic only — no wording changes.

The Italian locale landed with a plain hyphen where the rest of the reference uses dashes. It is most visible in the locale list, where the two lines now sit next to each other:

🌐 [Italiano](../i18n/rules/it/README.md) - model rules (`DOL011`-`DOL015`)
🌐 [Tiếng Việt](../i18n/rules/vi/README.md) — queryset rules (`DOL001`–`DOL007`)

This aligns Italian with the English source and the Vietnamese translation: em dash between the link and the description, en dash inside a rule range, and em dash after the rule ID in each page title.

Six files: the five DOL011-DOL015 titles and the locale line in docs/rules/README.md.

The django-orm-lens-disable-next-line directives inside the suppression examples contain hyphens too and are deliberately untouched — those are part of the directive syntax, not typography. Each edit was applied to the title line only and asserted against the directive count, so the fenced examples are byte-identical to before.

Summary by CodeRabbit

  • Documentation
    • Standardized title punctuation in Italian rule documentation.
    • Normalized dash usage and formatting in the rule reference page.
    • Preserved all rule descriptions, examples, severity details, suppression guidance, and analyzer instructions.

@coderabbitai

coderabbitai Bot commented Sep 2, 2026

Copy link
Copy Markdown

Review Change Stack

Warning

Review limit reached

Next included review available in 56 minutes.

Check out review usage here.

View limit details

Limit details: You’ve used the included review currently available.

You've used all free OSS reviews for now. Wait for the free limit to reset to keep reviewing this public repository.

Learn how review limits work.

Review configuration:

⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Team

Run ID: e45caf11-94d0-492b-8719-a63053dedd00

📥 Commits

Reviewing files that changed from the base of the PR and between 8f526a3 and 126c609.

📒 Files selected for processing (6)
  • docs/i18n/rules/it/DOL011.md
  • docs/i18n/rules/it/DOL012.md
  • docs/i18n/rules/it/DOL013.md
  • docs/i18n/rules/it/DOL014.md
  • docs/i18n/rules/it/DOL015.md
  • docs/rules/README.md

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Team

Run ID: 6013b3d1-031f-45fc-aa76-02092cde9569

📥 Commits

Reviewing files that changed from the base of the PR and between 9e56bb7 and 8f526a3.

📒 Files selected for processing (6)
  • docs/i18n/rules/it/DOL011.md
  • docs/i18n/rules/it/DOL012.md
  • docs/i18n/rules/it/DOL013.md
  • docs/i18n/rules/it/DOL014.md
  • docs/i18n/rules/it/DOL015.md
  • docs/rules/README.md

Included review availability: Your plan provides up to 1 included review per hour; 0 remain after this review.


📝 Walkthrough

Walkthrough

Changes

Documentation typography

Layer / File(s) Summary
Rule documentation formatting
docs/i18n/rules/it/DOL011.md, docs/i18n/rules/it/DOL012.md, docs/i18n/rules/it/DOL013.md, docs/i18n/rules/it/DOL014.md, docs/i18n/rules/it/DOL015.md, docs/rules/README.md
Italian rule headings and reference-page language links use consistent em-dash formatting. Rule content and semantics remain unchanged.

Estimated code review effort: 1 (Trivial) | ~2 minutes

Merge Risk: ⚪ Minimal · up to 8f526

This change only updates Italian documentation punctuation and does not alter wording, code examples, configuration, or runtime behavior. No actionable merge-blocking risk remains beyond normal checks and review.

Suggested reviewers: jjordan0c

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title clearly summarizes the documentation-only change: it updates dash typography in the Italian index entry and the DOL011–DOL015 titles.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check. Docstring coverage is scoped to functions touched by this diff. Analyzed 0 functions across 0…
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.
Full details: Docstring Coverage

Explanation

No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check. Docstring coverage is scoped to functions touched by this diff. Analyzed 0 functions across 0 files. (6 skipped: 6 unsupported.)

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch docs/it-dash-typography

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

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

@FROWNINGdev
FROWNINGdev merged commit d7a0ba5 into main Sep 2, 2026
18 checks passed
@FROWNINGdev
FROWNINGdev deleted the docs/it-dash-typography branch September 2, 2026 05:39
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.

1 participant