Skip to content

docs: record the rule behind generator target names - #48

Merged
owenthcarey merged 1 commit into
mainfrom
docs/target-naming-rationale
Sep 17, 2026
Merged

owenthcarey merged 1 commit into
mainfrom
docs/target-naming-rationale

Conversation

@owenthcarey

@owenthcarey owenthcarey commented Sep 17, 2026 •

Copy link
Copy Markdown
Contributor

Follow-up to #47, which renamed the android target to kotlin.

Adds a Target names subsection to docs/src/reference/naming.md so the reasoning behind target names is written down once instead of being rediscovered whenever a generator is added or the dotnet vs kotlin asymmetry is noticed. It states the rule:

  • name the target after the language when the emitted surface is idiomatic to one language (swift, python, kotlin, ...);
  • name it after the runtime when several languages consume the output equally (dotnet, node, wasm);
  • never name it after a deployment platform; platforms are settings under [generators.<target>].

It then records why dotnet (not csharp) and kotlin (not android or jvm) both follow from that rule, and gives new generators a test to apply.

Verification: scripts/check-links.sh passes locally against v0.23.0 main. Docs-only change; no code touched.

Base automatically changed from feat/abi-2-callback-interfaces to main September 17, 2026 03:42
@owenthcarey
owenthcarey force-pushed the docs/target-naming-rationale branch from 1611876 to b08d116 Compare September 17, 2026 03:55
@owenthcarey
owenthcarey marked this pull request as ready for review September 17, 2026 03:56
Add a Target names section to the naming reference that states how a
generator's target is named (after the language when the output is
idiomatic to one language, after the runtime when several languages
consume it equally, never after a deployment platform), and records why
dotnet and kotlin are both applications of that rule, including why the
android target became kotlin in schema 0.9.0.
@owenthcarey
owenthcarey force-pushed the docs/target-naming-rationale branch from b08d116 to 40eaa11 Compare September 17, 2026 04:06
@owenthcarey
owenthcarey merged commit 8548fef into main Sep 17, 2026
25 of 26 checks passed
@owenthcarey
owenthcarey deleted the docs/target-naming-rationale branch September 17, 2026 04:22
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