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

Getters not recognised by TypeDoc #234

Closed
ltfschoen opened this issue Oct 10, 2018 · 5 comments
Closed

Getters not recognised by TypeDoc #234

ltfschoen opened this issue Oct 10, 2018 · 5 comments

Comments

@ltfschoen
Copy link
Contributor

ltfschoen commented Oct 10, 2018

If we use TypeDoc for TypeScript Getters i.e. get, as follows:

export default class Rpc implements RpcInterface {
  private _provider: ProviderInterface;

  constructor (provider: ProviderInterface) {
    this._provider = provider;
  }

  /**
   * @example
   * <BR>
   *
   * ```javascript
   * <insert_example_here>
   * ```
   */
  get provider (): ProviderInterface { return this._provider; }
...

When we render it in Gitbooks by running: yarn; yarn run build; yarn gitbook serve and then viewing the relevant page after opening http://localhost:4000, it renders as getprovider() instead of get provider() (i.e. there's no space between).
Note that this may also be an issue with Setters.

@amaury1093
Copy link
Contributor

Should probably open an issue on gitbook

@ltfschoen
Copy link
Contributor Author

@amaurymartiny I've created an issue in the TypeDoc repo TypeStrong/typedoc#882.

@amaury1093
Copy link
Contributor

Yes correct, should be in typedoc not in gitbook

@jacogr
Copy link
Member

jacogr commented Dec 20, 2018

Closing here, nothing that we can do until fixed upstream - as updated, will update dev packages.

@jacogr jacogr closed this as completed Dec 20, 2018
@polkadot-js-bot
Copy link

This thread has been automatically locked since there has not been any recent activity after it was closed. Please open a new issue if you think you have a related problem or query.

@polkadot-js polkadot-js locked as resolved and limited conversation to collaborators Jun 6, 2021
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

No branches or pull requests

4 participants