custom metadata for notebook document.

extensions/vscode-notebook-tests/src/notebook.test.ts

@@ -328,7 +328,7 @@ suite('metadata', () => {
 
 		await waitFor(500);
 		assert.equal(vscode.notebook.activeNotebookEditor !== undefined, true, 'notebook first');
-		assert.equal(vscode.notebook.activeNotebookEditor!.document.metadata.custom['testMetadata'] as boolean, false);
+		assert.equal(vscode.notebook.activeNotebookEditor!.document.metadata.custom!['testMetadata'] as boolean, false);
 		assert.equal(vscode.notebook.activeNotebookEditor!.selection?.metadata.custom!['testCellMetadata'] as number, 123);
 		assert.equal(vscode.notebook.activeNotebookEditor!.selection?.language, 'typescript');
 	});

src/vs/vscode.proposed.d.ts

@@ -1642,9 +1642,9 @@ declare module 'vscode' {
 		displayOrder?: GlobPattern[];
 
 		/**
-		 * Additional attributes of a cell metadata.
+		 * Additional attributes of the document metadata.
 		 */
-		[key: string]: any;
+		custom?: { [key: string]: any };
 	}
 
 	export interface NotebookDocument {
@@ -1685,7 +1685,9 @@ declare module 'vscode' {
 		 * The primary selected cell on this notebook editor.
 		 */
 		readonly selection?: NotebookCell;
+
 		viewColumn?: ViewColumn;
+
 		/**
 		 * Fired when the output hosting webview posts a message.
 		 */

src/vs/workbench/contrib/notebook/browser/notebookEditor.ts

@@ -124,6 +124,7 @@ export class NotebookEditor extends BaseEditor {
 	}
 
 	clearInput(): void {
+		// de-ref widget
 		super.clearInput();
 	}
 

src/vs/workbench/contrib/notebook/browser/notebookEditorInput.ts

@@ -119,6 +119,7 @@ export class NotebookEditorInput extends EditorInput {
 		return this._move(group, target)?.editor;
 	}
 
+	// called when users rename a notebook document
 	move(group: GroupIdentifier, target: URI): IMoveResult | undefined {
 		if (this.textModel) {
 			const contributedNotebookProviders = this.notebookService.getContributedNotebookProviders(target);