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

Remove all types in JSDoc/TypeDoc comments #1200

Open
raucao opened this issue Sep 23, 2020 · 0 comments
Open

Remove all types in JSDoc/TypeDoc comments #1200

raucao opened this issue Sep 23, 2020 · 0 comments

Comments

@raucao
Copy link
Member

raucao commented Sep 23, 2020

We don't need to document the types in the comments anymore, because TypeDoc can extract them automatically from the code itself.

(#1199 is completing the TypeDoc switch, but not implementing all available features yet.)

Here's an example for how you can contribute:

diff --git a/src/baseclient.ts b/src/baseclient.ts
index 91c03cc5..bdc61d7d 100644
--- a/src/baseclient.ts
+++ b/src/baseclient.ts
@@ -59,10 +59,9 @@ class BaseClient {
    * Instantiate a new client, scoped to a subpath of the current client's
    * path.
    *
-   * @param {string} path - The path to scope the new client to.
+   * @param path - The path to scope the new client to
    *
-   * @returns {BaseClient} A new client operating on a subpath of the current
-   *                       base path.
+   * @returns  A new client operating on a subpath of the current base path
    */
   scope (path: string): BaseClient {
     return new BaseClient(this.storage, this.makePath(path));
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Development

No branches or pull requests

1 participant