Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Language Specific Nomenclature #658

Open
MrArnoldPalmer opened this issue Apr 14, 2022 · 0 comments
Open

Language Specific Nomenclature #658

MrArnoldPalmer opened this issue Apr 14, 2022 · 0 comments
Labels
feature-request A feature should be added or improved. p2

Comments

@MrArnoldPalmer
Copy link
Contributor

Something to consider for jsii-docgen is that the nomenclature of "constructs, classes, structs, protocols, enums, etc" may not be terms that are familiar to users of a specific language. For example, Go obviously doesn't have classes, and "protocols" are a concept that map to Go interfaces, but constructs and classes are both also generated as Go interfaces in JSII.

This makes the docs generated for Go potentially unfamiliar to users of the language. Where they are expecting to see a bunch of free floating functions and struct/interface definitions, they are instead required to understand the constructs programming model and how that is translated to Go by JSII. This leakiness prevents providing an idiomatic experience in target languages as far as documentation is concerned.

@mrgrain mrgrain added feature-request A feature should be added or improved. p2 labels Jun 10, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
feature-request A feature should be added or improved. p2
Projects
None yet
Development

No branches or pull requests

2 participants