Skip to content

feat: add Effective Python semantic anchor (EN + DE) - #694

Merged
JensGrote merged 1 commit into
LLM-Coding:mainfrom
derryx:add-effective-python
Jul 14, 2026
Merged

feat: add Effective Python semantic anchor (EN + DE)#694
JensGrote merged 1 commit into
LLM-Coding:mainfrom
derryx:add-effective-python

Conversation

@derryx

@derryx derryx commented Jul 13, 2026

Copy link
Copy Markdown
Contributor

Summary

Adds the Effective Python semantic anchor, completing the "Effective *" family alongside the existing effective-java and effective-go anchors.

  • docs/anchors/effective-python.adoc (EN) and effective-python.de.adoc (DE)
  • Category development-workflow; roles software-developer, software-architect; related to effective-java, effective-go, solid-principles
  • Core Concepts cover Pythonic thinking (PEP 8 / Zen of Python), comprehensions & generators, functions, classes/@property, the GIL & concurrency (asyncio, concurrent.futures), and robustness/testing
  • Current Status section is fetch-verified: cites the 3rd edition (125 Items, published 20 Nov 2024, Pearson Addison-Wesley, ISBN 978-0-13-817218-3) and notes a training-data prior most plausibly reflects the 2nd edition (90 Items)
  • No Criticism section: no citable named critic found, consistent with the effective-java/effective-go siblings

Housekeeping

  • Updated the AgentSkill catalog (skill/.../catalog.md) and synced the plugin copy (plugins/.../catalog.md)
  • Regenerated website/public/data/*.json via npm run extract-metadata (188 → 189 anchors)

Verification

  • extract-metadata parses the new .adoc cleanly; anchor appears in anchors.json with correct metadata
  • EN/DE metadata parity maintained

🤖 Generated with Claude Code

Summary by CodeRabbit

  • Dokumentation
    • „Effective Python“ wurde als neue deutsch- und englischsprachige Ressourcenübersicht ergänzt.
    • Die Übersicht fasst rund 125 Python-Best Practices zusammen, darunter PEP 8, Generatoren, Comprehensions, Funktionen, Klassen, Testen und Nebenläufigkeit.
    • Ergänzt wurden Einsatzszenarien, aktuelle Editionsinformationen, Metadaten sowie Verweise auf verwandte Ressourcen.
    • Die Ressource ist nun auch in den relevanten Katalogen und Übersichten auffindbar.

@coderabbitai

coderabbitai Bot commented Jul 13, 2026

Copy link
Copy Markdown
Contributor

Review Change Stack

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Path: .coderabbit.yml

Review profile: CHILL

Plan: Pro

Run ID: 85e7c211-05b5-4ef2-8839-9445cea839e0

📥 Commits

Reviewing files that changed from the base of the PR and between b781eff and f3ff5be.

📒 Files selected for processing (4)
  • docs/anchors/effective-python.adoc
  • docs/anchors/effective-python.de.adoc
  • plugins/semantic-anchors/skills/semantic-anchor-translator/references/catalog.md
  • skill/semantic-anchor-translator/references/catalog.md
🚧 Files skipped from review as they are similar to previous changes (4)
  • docs/anchors/effective-python.adoc
  • docs/anchors/effective-python.de.adoc
  • plugins/semantic-anchors/skills/semantic-anchor-translator/references/catalog.md
  • skill/semantic-anchor-translator/references/catalog.md

Walkthrough

Die Änderungen ergänzen englische und deutsche AsciiDoc-Ankerseiten für „Effective Python“ sowie entsprechende Einträge in zwei Katalogdateien. Dokumentiert werden Metadaten, Best Practices, Einsatzszenarien, verwandte Anchors und Angaben zur dritten Auflage.

Changes

Effective-Python-Integration

Layer / File(s) Zusammenfassung
Anchor-Dokumentation und Katalogisierung
docs/anchors/effective-python*.adoc, */semantic-anchor-translator/references/catalog.md
Die englische und deutsche Anchor-Seite sowie beide Kataloge ergänzen Inhalte, Metadaten und Best-Practice-Beschreibungen zu „Effective Python“.

Estimated code review effort: 2 (Einfach) | ~10 Minuten

Possibly related PRs

🚥 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 Der Titel beschreibt präzise das Hauptthema der Änderung: den neuen Effective-Python-Semantic-Anchor in Englisch und Deutsch.
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.
✨ 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.

@JensGrote

Copy link
Copy Markdown
Collaborator

Review: effective-python anchor (EN + DE)

Quality Criteria

Criterion Verdict
✓ Precise ✅ Specific book, 125 Items, 3 editions, clear boundaries
✓ Rich ✅ Activates: Pythonic thinking, comprehensions, generators, GIL, asyncio, @Property, keyword-only args, venv, unittest
✓ Consistent ✅ Canonical book with no interpretation ambiguity
✓ Attributable ✅ Brett Slatkin, Addison-Wesley, ISBN 978-0-13-817218-3

Viability

★★★ Self-standing — naming "Effective Python" alone reliably restructures LLM output around Items and Pythonic patterns. Consistent with siblings (effective-java ★★★, effective-go ★★★).

Structural Comparison with Siblings

Aspect effective-java effective-go effective-python Verdict
:tier: 3 3 missing 🚩
Core Concepts entries 10 10 10
When to Use bullets 5 5 5
Related Anchors 3 2 3
Current Status bullets 3 3 3
Criticism section none none none ✅ consistent
Category development-workflow development-workflow development-workflow
Roles dev, architect dev, architect dev, architect

The "Effective *" family is now structurally consistent — same depth, same format, same scope.

Metadata & Format

  • :categories:, :roles:, :proponents:, :tags:, :related: — all present ✅
  • EN/DE parity ✅
  • Current Status fetch-verified (Informit link, effectivepython.com, ISBN, publication date all confirmed) ✅
  • No Criticism section — correct per CONTRIBUTING ("omit if nothing citable found"), consistent with siblings ✅
  • Catalog entries updated (both skill/ and plugins/) ✅

🚩 Requested Changes

1. Add :tier: 3 to both .adoc files (EN + DE). Both siblings (effective-java, effective-go) carry :tier: 3. Currently missing.

2. Drop website/public/data/*.json — these are build artifacts and not committed by convention. Ralf flagged the same issue on #659:

"Commits generated data — website/public/data/*.json are rebuilt by the build and are not committed by convention (no recent anchor PR includes them). Please drop them."

The diff contains 200+ lines of unrelated noise from running npm run extract-metadata:

Summary

Content is solid — well-researched, structurally consistent with the "Effective *" family, all facts verified. Just needs the tier field and the generated files dropped.


Deutsche Version

Review: effective-python Anchor (EN + DE)

Qualitätskriterien

Kriterium Ergebnis
✓ Precise ✅ Spezifisches Buch, 125 Items, 3 Auflagen, klare Grenzen
✓ Rich ✅ Aktiviert: Pythonic Thinking, Comprehensions, Generators, GIL, asyncio, @Property, keyword-only args, venv, unittest
✓ Consistent ✅ Kanonisches Buch ohne Interpretationsspielraum
✓ Attributable ✅ Brett Slatkin, Addison-Wesley, ISBN 978-0-13-817218-3

Viability

★★★ Self-standing — allein die Nennung von „Effective Python" restrukturiert die LLM-Ausgabe zuverlässig um Items und Pythonic Patterns. Konsistent mit den Siblings (effective-java ★★★, effective-go ★★★).

Struktureller Vergleich mit Siblings

Aspekt effective-java effective-go effective-python Ergebnis
:tier: 3 3 fehlt 🚩
Core Concepts Einträge 10 10 10
When to Use Bullets 5 5 5
Related Anchors 3 2 3
Current Status Bullets 3 3 3
Criticism-Section keine keine keine ✅ konsistent
Category development-workflow development-workflow development-workflow
Roles dev, architect dev, architect dev, architect

Die „Effective *"-Familie ist strukturell konsistent — gleiche Tiefe, gleiches Format, gleicher Scope.

Metadata & Format

  • :categories:, :roles:, :proponents:, :tags:, :related: — vollständig vorhanden ✅
  • EN/DE-Parität ✅
  • Current Status fetch-verifiziert (Informit-Link, effectivepython.com, ISBN, Erscheinungsdatum bestätigt) ✅
  • Keine Criticism-Section — korrekt gemäß CONTRIBUTING („omit if nothing citable found"), konsistent mit Siblings ✅
  • Catalog-Einträge aktualisiert (sowohl skill/ als auch plugins/) ✅

🚩 Requested Changes

1. :tier: 3 ergänzen in beiden .adoc-Dateien (EN + DE). Beide Siblings (effective-java, effective-go) tragen :tier: 3. Fehlt aktuell.

2. website/public/data/*.json entfernen — das sind Build-Artefakte, die per Convention nicht committet werden. Ralf hat dasselbe Problem bei #659 markiert:

„Commits generated data — website/public/data/*.json are rebuilt by the build and are not committed by convention (no recent anchor PR includes them). Please drop them."

Der Diff enthält 200+ Zeilen unrelated Noise aus npm run extract-metadata:

Zusammenfassung

Inhaltlich solide — gut recherchiert, strukturell konsistent mit der „Effective *"-Familie, alle Fakten verifiziert. Braucht nur das Tier-Feld und die generated files müssen raus.

Add the "Effective Python" anchor alongside its Effective Java/Go
siblings under development-workflow. Includes a fetch-verified Current
Status section citing the 3rd edition (125 Items, Nov 2024) and updates
the AgentSkill catalog. Metadata JSON regenerated via extract-metadata.

Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
@derryx
derryx force-pushed the add-effective-python branch from b781eff to f3ff5be Compare July 14, 2026 07:21
@derryx

derryx commented Jul 14, 2026

Copy link
Copy Markdown
Contributor Author

Thanks for the review, @JensGrote! Both requested changes are done:

  1. :tier: 3 added to both effective-python.adoc and effective-python.de.adoc — now consistent with effective-java and effective-go.
  2. website/public/data/*.json dropped — the generated files (timestamp normalization + name_de from feat: add role descriptions for all 15 roles (EN + DE) #691) are removed from the diff.

The PR now contains only the 4 intended files (2 anchor docs + 2 catalog entries). Force-pushed as f3ff5be.

@JensGrote
JensGrote merged commit bca33f2 into LLM-Coding:main Jul 14, 2026
9 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.

2 participants