From 5a77a22207181526f0ffb925fdcf76f1f459f2f8 Mon Sep 17 00:00:00 2001 From: Nicolas Brichet Date: Thu, 4 Aug 2022 13:48:54 +0200 Subject: [PATCH] Add some docstring --- packages/tree-extension/src/index.ts | 3 +-- packages/tree/src/notebook-tree.ts | 6 ++++++ packages/tree/src/token.ts | 3 +++ 3 files changed, 10 insertions(+), 2 deletions(-) diff --git a/packages/tree-extension/src/index.ts b/packages/tree-extension/src/index.ts index 4320e814b..f9bcb8040 100644 --- a/packages/tree-extension/src/index.ts +++ b/packages/tree-extension/src/index.ts @@ -32,8 +32,7 @@ import { import { Menu, MenuBar } from '@lumino/widgets'; -import { NotebookTreeWidget } from '@jupyter-notebook/tree'; -import { INotebookTree } from '@jupyter-notebook/tree'; +import { NotebookTreeWidget, INotebookTree } from '@jupyter-notebook/tree'; /** * The file browser factory. diff --git a/packages/tree/src/notebook-tree.ts b/packages/tree/src/notebook-tree.ts index 85fd387c3..28dad32c5 100644 --- a/packages/tree/src/notebook-tree.ts +++ b/packages/tree/src/notebook-tree.ts @@ -4,7 +4,13 @@ import { TabPanel } from '@lumino/widgets'; import { INotebookTree } from './token'; +/** + * The widget added in main area of the tree view. + */ export class NotebookTreeWidget extends TabPanel implements INotebookTree { + /** + * Constructor of the NotebookTreeWidget. + */ constructor() { super({ tabPlacement: 'top', diff --git a/packages/tree/src/token.ts b/packages/tree/src/token.ts index 7ae940953..70342c9e7 100644 --- a/packages/tree/src/token.ts +++ b/packages/tree/src/token.ts @@ -1,6 +1,9 @@ import { Token } from '@lumino/coreutils'; import { TabPanel } from '@lumino/widgets'; +/** + * The INotebookTree interface. + */ export interface INotebookTree extends TabPanel {} /**