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
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));
The text was updated successfully, but these errors were encountered:
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:
The text was updated successfully, but these errors were encountered: