Fix brand casing (Zenrows, not ZenRows) in the new src/ layout - #18
Merged
Conversation
Per commit 9f1f00c6d: user-facing prose spells the brand "Zenrows" (capital Z, lowercase r); only published identifiers (ZenRowsClient, ZenRowsBatchClient) and things copied verbatim from zenrows-web's own (unrevised) authoritative Batch API spec stay "ZenRows"-cased. The feature/batch-api/rc restructuring introduced this src/ layout after the earlier casing sweep (Part 6 of the audit) had already run against the old flat layout, so these five spots were never checked: module docstrings in __init__.py/batch/__init__.py/batch/client.py, the doc-generator's hardcoded title, and one locally-authored (not copied from the authoritative spec) line in openapi.yaml. docs/batch-client-reference.md and models.py are generated — fixed via `make docs`/`make generate` against the corrected sources rather than hand-edited; diffs confirmed to carry only the intended text change plus the generator's timestamp comment. openapi.yaml's title and top-level description stay "ZenRows", verified verbatim-identical to zenrows-web's own unrevised docs/api/conveyor/api.md — diverging from the authoritative source would be worse than the casing miss itself.
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
1 participant
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.
Summary
The
feature/batch-api/rcrestructuring (merged tomainvia #13) introduced the currentsrc/zenrows/layout after the earlier brand-casing sweep had already run against the old flat layout — so these five spots were never checked against the "Zenrows, not ZenRows" rule (per commit 9f1f00c6d: user-facing prose stays "Zenrows"; published identifiers likeZenRowsClient/ZenRowsBatchClientstay "ZenRows").Fixed:
src/zenrows/__init__.py,src/zenrows/batch/__init__.py,src/zenrows/batch/client.py— module/class docstringsscripts/build_reference.py— the doc generator's hardcoded titledocs/openapi.yaml— one locally-authored line (gateway_errordescription), not copied from the authoritative specRegenerated rather than hand-edited (both are generated, "do not hand-edit" per their own headers):
src/zenrows/batch/models.pyviamake generatedocs/batch-client-reference.mdviamake docsBoth diffs confirmed to carry only the intended text change plus the generator's timestamp comment — no other regeneration drift.
Deliberately left as "ZenRows":
docs/openapi.yaml'stitleand top-leveldescription— verified verbatim-identical tozenrows-web's own unreviseddocs/api/conveyor/api.md. Diverging from the authoritative source's own (unrevised) casing would be worse than the miss itself, matching the established precedent from the original casing sweep.Verification
grep -rn "ZenRows" README.md docs/ src/zenrows/ scripts/*.py, filtered for known-correct identifiers) — zero remaining violations besides the two intentionally-preserved openapi.yaml lines.make check(typecheck/lint/format) clean.make test— 126/126 pass.make build— builds clean, package imports correctly.https://claude.ai/code/session_01DTXXBERPGEnYiYP4Mt3FjF