Skip to content

docs(i18n): add Italian queryset rule translations - #100

Merged
FROWNINGdev merged 2 commits into
FROWNINGdev:mainfrom
JJordan0C:fix/italian-queryset-rule-translations
Sep 2, 2026
Merged

docs(i18n): add Italian queryset rule translations#100
FROWNINGdev merged 2 commits into
FROWNINGdev:mainfrom
JJordan0C:fix/italian-queryset-rule-translations

Conversation

@JJordan0C

@JJordan0C JJordan0C commented Sep 2, 2026

Copy link
Copy Markdown
Contributor

Summary

Added Italian translations for the queryset rule family (DOL001 through DOL008). I read and write Italian and reviewed the wording for technical accuracy while keeping code blocks, rule identifiers, settings, QuickFix labels, and suppression syntax unchanged.

Updated the Italian locale index with the new family, expanded the coverage label in the complete rule reference, and recorded the addition in the changelog.

Type of change

  • Bug fix (non-breaking, restores expected behaviour)
  • Feature (non-breaking, adds a capability)
  • Breaking change (existing users have to update config or code)
  • Docs / README / comments only (no runtime effect)
  • Internal refactor (no behaviour change, no public API change)
  • Dependency bump
  • CI / build / tooling

Test plan

  • Compared all 24 fenced Python code blocks with the English source after repository line-ending normalization; their contents are identical.
  • Verified identical line counts and heading structure for every translated page.
  • Verified that inline technical tokens match the English source exactly.
  • Verified that category, default severity, and applicability match the canonical index for all eight rules.
  • Verified that every relative Markdown link in the Italian locale resolves.
  • Ran npm test: 242 tests passed.
  • Ran cd cli && python -m pytest -q: 475 tests and 41 subtests passed, with 2 tests skipped.
  • Ran cd cli && python -m ruff check django_orm_lens tests: passed.
  • Ran cd cli && python -m mypy django_orm_lens: passed.
  • Ran git diff --check: passed.

Checklist

  • I ran the full test suite locally (cd cli && pytest -q for Python, npm test for TypeScript) and it is green
  • I added or updated tests that cover the change (bugfixes should get a regression test)
  • If the change is user-facing I updated the CHANGELOG under ## [Unreleased]
  • If the change touches the MCP tool contract (new tool, new arg, new error code) I updated the tool description in mcp_server.py and the relevant tests in test_mcp_server.py
  • If this is a breaking change I called it out under ## Summary above and suggested a migration path

The unchecked items do not apply because this PR changes Markdown documentation only and does not change runtime behavior or the MCP contract.

Related issues / discussions

Closes #98

Refs #52

Summary by CodeRabbit

  • Documentation
    • Added Italian documentation for queryset rules DOL001–DOL008, including examples, guidance, severities, and configuration options.
    • Updated the Italian rules index with links and details for DOL001–DOL008.
    • Updated the main rules reference to include Italian queryset and model rule documentation.
    • Added an Unreleased changelog entry for the Italian translations.

@coderabbitai

coderabbitai Bot commented Sep 2, 2026

Copy link
Copy Markdown

Review Change Stack

Warning

Review limit reached

Next included review available in 47 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: 7258da34-2750-432b-9cf2-cf796ce1d25f

📥 Commits

Reviewing files that changed from the base of the PR and between 679fc1a and c5a7574.

📒 Files selected for processing (9)
  • docs/i18n/rules/it/DOL001.md
  • docs/i18n/rules/it/DOL002.md
  • docs/i18n/rules/it/DOL003.md
  • docs/i18n/rules/it/DOL004.md
  • docs/i18n/rules/it/DOL005.md
  • docs/i18n/rules/it/DOL006.md
  • docs/i18n/rules/it/DOL007.md
  • docs/i18n/rules/it/DOL008.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: 8777b680-2273-442e-b720-4d0fa1094714

📥 Commits

Reviewing files that changed from the base of the PR and between d7a0ba5 and 679fc1a.

📒 Files selected for processing (11)
  • CHANGELOG.md
  • docs/i18n/rules/it/DOL001.md
  • docs/i18n/rules/it/DOL002.md
  • docs/i18n/rules/it/DOL003.md
  • docs/i18n/rules/it/DOL004.md
  • docs/i18n/rules/it/DOL005.md
  • docs/i18n/rules/it/DOL006.md
  • docs/i18n/rules/it/DOL007.md
  • docs/i18n/rules/it/DOL008.md
  • docs/i18n/rules/it/README.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

Added Italian documentation for queryset rules DOL001–DOL008. Updated the Italian rule index, the main rule-reference link, and the unreleased changelog.

Changes

Italian queryset documentation

Layer / File(s) Summary
Basic queryset rule pages
docs/i18n/rules/it/DOL001.md, docs/i18n/rules/it/DOL002.md, docs/i18n/rules/it/DOL003.md, docs/i18n/rules/it/DOL004.md, docs/i18n/rules/it/DOL005.md, docs/i18n/rules/it/DOL006.md
Added Italian descriptions, metadata, code examples, QuickFix details, and suppression instructions for DOL001–DOL006.
Advanced queryset rule pages
docs/i18n/rules/it/DOL007.md, docs/i18n/rules/it/DOL008.md
Added Italian documentation for N+1 detection and lookup typo detection, including scope, exclusions, examples, and suppression options.
Documentation navigation and changelog
docs/i18n/rules/it/README.md, docs/rules/README.md, CHANGELOG.md
Linked DOL001–DOL008 from the Italian index, updated the main Italian rule-reference description, and added an unreleased changelog entry.

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

Merge Risk: ⚪ Minimal · up to 679fc

This PR adds Italian documentation for queryset rules and updates the related indexes and changelog without changing runtime behavior. The documented content matches the English structure and normal checks are passing, so no actionable merge-blocking risk remains.

🚥 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 and concisely describes the main change: adding Italian translations for queryset rules.
Linked Issues check ✅ Passed The PR adds DOL001.md through DOL008.md, updates the Italian locale index, preserves the documented metadata and technical syntax, and matches the linked issue scope for completing the Italian queryse…
Out of Scope Changes check ✅ Passed The changelog entry and the expanded rule-reference label support the documented translation work. No unrelated runtime or contract changes are reported.
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…
Full details: Linked Issues check

Explanation

The PR adds DOL001.md through DOL008.md, updates the Italian locale index, preserves the documented metadata and technical syntax, and matches the linked issue scope for completing the Italian queryset rule reference [#98].

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. (11 skipped: 11 unsupported.)

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests

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 left a comment

Copy link
Copy Markdown
Owner

Choose a reason for hiding this comment

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

Checked this the same way as #95 — mechanically against the English source, not for fluency. The translation itself is clean:

  • All 24 fenced code blocks are byte-identical to the English originals. Your own count matches mine exactly.
  • Line counts track the source page for page: 27/27/27/27/27/27/51/58.
  • Heading levels and order match, rule IDs intact, no stray carriage returns.
  • The index table repeats the canonical metadata field for field, including the row that is easiest to get wrong: DOL008 is correctness, not queryset, and you have it as correctness. Everything else matches docs/rules/README.md exactly.
  • Splitting the index into Regole sui queryset and the existing model section is the right structure, and updating the intro sentence to name both families was a nice touch.

One thing needs changing, and it is the same dash nit as last time — except this round it reverts a merged fix rather than merely missing a convention.

Your branch point is d7a0ba5, which is the merge commit of #97, so the em dash was already in your base:

-🌐 [Italiano](../i18n/rules/it/README.md) — model rules (`DOL011`–`DOL015`)
+🌐 [Italiano](../i18n/rules/it/README.md) - queryset and model rules (`DOL001`-`DOL008`, `DOL011`-`DOL015`)

Merging as-is would put that line back to a hyphen four hours after it was normalised, and the Vietnamese line directly below it would visibly disagree again. The same applies to the eight new page titles, which use DOL001 - ... where English and Vietnamese use an em dash.

The convention, so it is written down somewhere you can point at:

  • em dash () between a rule ID and its title, and between a locale link and its description
  • en dash () inside a rule range, e.g. DOL001DOL008
  • plain hyphens stay untouched inside code, identifiers and django-orm-lens-disable-next-line

Nine lines total: the eight # DOL00N - titles and the locale line. Push it and I will merge — or say the word and I will fold it in on merge, same as last time. Your call; I would rather not have you spend a second round on punctuation when the actual translation has come back perfect twice running.

@JJordan0C

Copy link
Copy Markdown
Contributor Author

Thanks for the detailed review. I applied the requested typography changes in c5a7574: em dashes in all eight rule titles and the locale separator, plus en dashes in both rule ranges. I also rechecked that all 24 Python code blocks remain identical to the English source and that every relative Markdown link still resolves.

@FROWNINGdev FROWNINGdev left a comment

Copy link
Copy Markdown
Owner

Choose a reason for hiding this comment

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

Verified c5a7574 and merging.

The fix is exactly nine lines, +1/-1 across nine files, and nothing else moved. Re-ran the same checks against the new head rather than trusting the diff:

  • All eight titles now carry an em dash; the locale line carries an em dash plus en dashes in both ranges, so it finally agrees with the Vietnamese line under it.
  • The 24 code blocks are still byte-identical to the English source — the typography pass did not leak into a fence.
  • Line counts, heading structure and line endings unchanged.

Seven minutes from review to a surgical fix, and the translation itself came back clean twice running. #98 closes with this.

For what it is worth, the convention is now written down in the review above, so the next locale does not have to rediscover it. If you do take Spanish (#99), it is the same shape as this one and the index is the useful half — that is the piece that turns scattered pages into a section someone can navigate.

@FROWNINGdev
FROWNINGdev merged commit e613a55 into FROWNINGdev:main Sep 2, 2026
18 checks passed
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.

Finish the Italian rule reference — the queryset family DOL001–DOL008

2 participants