Sphinx: in generated refs, show the name of the package in all supported languages #74
Assignees
Comments
RomainMuller
added a commit
that referenced
this issue
Aug 2, 2018
Each `Target` implementation can contribute to this process by providing two static functions that allow the sphinx generator to obtain: * The package coordinates in the "standard" registry (e.g: maven) for an assembly * The native name (or names) for a given `Type`. There can be multiple names in case the artifacts can be used across different languages, for example Javascript & TypeScript share names, but `InterfaceType`s are not visible in Javascript. The C# names are not included, because the process to come up with those names is factored in the C# code, and the dis-ambiguation is complex to reproduce. This omission will be corrected at a later point in time. Fixes #74
RomainMuller
added a commit
that referenced
this issue
Aug 6, 2018
Each `Target` implementation can contribute to this process by providing two static functions that allow the sphinx generator to obtain: * Package information, including the URL to the (arguably) "canonical" repository for a given language (e.g: java => maven central, javascript => npmjs) as well as snippets of code to use in order to use the package. * The native name (or names) for a given `Type`. There can be multiple names in case the artifacts can be used across different languages, for example Javascript & TypeScript share names, but `InterfaceType`s are not visible in Javascript. Java classes can be used in Scala & Clojure (possibly with slight syntax variations), etc... The C# names are not included, because the process to come up with those names is factored in the C# code, and the dis-ambiguation is complex to reproduce. This omission will be corrected at a later point in time. Fixes #74 Causes #149
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
No description provided.
The text was updated successfully, but these errors were encountered: