Skip to content

Formatting nits#54

Merged
etbyrd merged 2 commits into
mainfrom
prose-nits
May 6, 2026
Merged

Formatting nits#54
etbyrd merged 2 commits into
mainfrom
prose-nits

Conversation

@etbyrd
Copy link
Copy Markdown
Member

@etbyrd etbyrd commented May 6, 2026

Summary

  • Replace U+2014 with comma, period, semicolon, or colon across the OpenAPI spec, hand-written SDK comments and docstrings, the @primitivedotdev/sdk npm description, the repo's CLAUDE.md, and a couple of test comments.
  • The most visible change is the discardEmailContent description in openapi/primitive-api.yaml, which is rendered into JSDoc, the Python docstring, the Go method comment, and the CLI --help output for primitive emails:discard-email-content.
  • Second commit regenerates the SDKs from the cleaned spec so generated artifacts stay in sync.

Notes

  • Left alone: the unicode subject test fixture in sdk-node/tests/contract/contract.test.ts (Resume from ...) deliberately exercises non-ASCII handling in subject lines.
  • Left alone: docstrings in sdk-python/src/primitive/api/client.py are emitted by the openapi-python-client template upstream, not under our control without forking the template. They will not show up in any user-facing description we ship.

Test plan

  • make node-check-generated clean
  • make python-check-generated clean
  • make go-check-generated clean
  • CI green

etbyrd added 2 commits May 6, 2026 13:49
Replace U+2014 with comma, period, semicolon, or colon as the
sentence reads best. The OpenAPI description for discardEmailContent
gets the most visible fix, since that text is rendered into
generated SDK docstrings and CLI --help output. None of the affected
strings change meaning or break parsing; the contract.test.ts
unicode-subject fixture is intentionally left alone.

Generated files will follow in the next commit (regenerate from
the updated spec).
Picks up the discardEmailContent description rewrite from the
previous commit so the JSDoc, Python docstring, Go comment, and
CLI --help output stop carrying an em dash.
@etbyrd etbyrd changed the title Drop em dashes from prose Formatting nits May 6, 2026
@greptile-apps
Copy link
Copy Markdown

greptile-apps Bot commented May 6, 2026

Greptile Summary

This PR removes all U+2014 em dashes from prose across the repository, replacing them with commas, periods, semicolons, or colons as appropriate. The SDKs are then regenerated so every generated artifact stays in sync with the cleaned source.

  • Em dashes are replaced in the OpenAPI spec (primitive-api.yaml and primitive-api.codegen.json), which propagates consistently into all generated Go files, the Node sdk.gen.ts, the Python discard_email_content.py docstrings, and the two *.generated.ts manifests.
  • Hand-written comments and JSDoc in download-tokens.ts, contract.ts, sanitize-html.ts, attachment-parser.ts, and generate-openapi-artifacts.ts are also updated, as are two test comments in sdk-python/tests/test_validation.py and the package.json description field.

Confidence Score: 5/5

Safe to merge — every change is a punctuation substitution in a comment, docstring, or description string with no effect on runtime behaviour.

All 18 files touch only prose inside comments, JSDoc, docstrings, or static metadata. No logic, type signatures, schemas, or test assertions are altered. Generated artifacts are consistently regenerated from the cleaned source.

No files require special attention.

Important Files Changed

Filename Overview
openapi/primitive-api.yaml Em dash in discardEmailContent description replaced with a period; no functional change
openapi/primitive-api.codegen.json Em dash in discardEmailContent description replaced with a period, mirroring the YAML source
sdk-node/src/webhook/download-tokens.ts Multiple em dashes in JSDoc and inline comments replaced with colons, semicolons, and periods; no logic touched
sdk-node/package.json Package description em dash replaced with a colon; purely cosmetic
sdk-node/src/contract/contract.ts JSDoc comment for attachmentsDownloadUrl em dash replaced with a period; no behaviour change
sdk-python/src/primitive/api/api/emails/discard_email_content.py Four identical docstring occurrences of the em dash replaced with a period in sync with the OpenAPI source
sdk-go/api/oas_client_gen.go Generated Go comment updated to match the cleaned OpenAPI spec; no logic changes
sdk-node/src/parser/sanitize-html.ts Inline comment em dash replaced with a semicolon; no logic touched
sdk-python/tests/test_validation.py Two test comment em dashes replaced with semicolons; no test logic changed
CLAUDE.md Em dash in the "Warnings are errors" section replaced with a period, splitting one sentence into two

Reviews (1): Last reviewed commit: "Regenerate SDKs from updated spec" | Re-trigger Greptile

@etbyrd etbyrd merged commit 9544c03 into main May 6, 2026
9 checks passed
@etbyrd etbyrd deleted the prose-nits branch May 6, 2026 20:56
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