You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
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.
The text was updated successfully, but these errors were encountered:
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.
The text was updated successfully, but these errors were encountered: