update/tackle todos
This commit is contained in:
parent
6fe84c402b
commit
e8d8e53752
2 changed files with 103 additions and 71 deletions
143
.vscode/searches/api-todos.code-search
vendored
143
.vscode/searches/api-todos.code-search
vendored
|
@ -3,7 +3,7 @@
|
|||
# Including: */vscode.d.ts
|
||||
# ContextLines: 1
|
||||
|
||||
28 results - 1 file
|
||||
32 results - 1 file
|
||||
|
||||
src/vs/vscode.d.ts:
|
||||
11374 /** @deprecated */
|
||||
|
@ -22,82 +22,99 @@ src/vs/vscode.d.ts:
|
|||
11453: // todo@API decouple from metadata? extract as dedicated field or inside an options object and leave metadata purely for extensions?
|
||||
11454 readonly outputCollapsed?: boolean;
|
||||
|
||||
11496 */
|
||||
11497: // todo@API use duration instead of start/end? doesn't allow for only passing one
|
||||
11498 readonly startTime?: number;
|
||||
11497 // @rob
|
||||
11498: //todo@API think about invalid state (no end, but start and vice versa)
|
||||
11499 readonly startTime?: number;
|
||||
|
||||
11505
|
||||
11506: // todo@API jsdoc
|
||||
11507: // todo@API remove this and use simple {}?
|
||||
11508 export class NotebookDocumentMetadata {
|
||||
11506
|
||||
11507: // todo@API jsdoc
|
||||
11508: // todo@API remove this and use simple {}?
|
||||
11509 export class NotebookDocumentMetadata {
|
||||
|
||||
11644
|
||||
11645: //todo@API remove in favour of NotebookCellOutput#metadata
|
||||
11646 metadata?: { [key: string]: any };
|
||||
11645
|
||||
11646: //todo@API remove in favour of NotebookCellOutput#metadata
|
||||
11647 metadata?: { [key: string]: any };
|
||||
|
||||
11662 */
|
||||
11663: //todo@API - add sugar function to add more outputs
|
||||
11664 export class NotebookCellOutput {
|
||||
11663 */
|
||||
11664: //todo@API - add sugar function to add more outputs
|
||||
11665 export class NotebookCellOutput {
|
||||
|
||||
11706 */
|
||||
11707: //todo@API id-args is not used by jupyter but we it added with display_id in mind...
|
||||
11708 constructor(items: NotebookCellOutputItem[], id: string, metadata?: { [key: string]: any });
|
||||
11707 */
|
||||
11708: //todo@API id-args is not used by jupyter but we it added with display_id in mind...
|
||||
11709 // @jupyter check if needed
|
||||
|
||||
11757 */
|
||||
11758: // todo@API should ctors only have the args for required properties?
|
||||
11759 constructor(kind: NotebookCellKind, value: string, languageId: string, outputs?: NotebookCellOutput[], metadata?: NotebookCellMetadata, executionSummary?: NotebookCellExecutionSummary);
|
||||
11759 */
|
||||
11760: // todo@API should ctors only have the args for required properties?
|
||||
11761 constructor(kind: NotebookCellKind, value: string, languageId: string, outputs?: NotebookCellOutput[], metadata?: NotebookCellMetadata, executionSummary?: NotebookCellExecutionSummary);
|
||||
|
||||
11841 */
|
||||
11842: // todo@API ...NotebookDocument... or just ...Notebook... just like...Cell... above
|
||||
11843 transientDocumentMetadata?: { [K in keyof NotebookDocumentMetadata]?: boolean };
|
||||
11849 */
|
||||
11850: //todo@API inline?
|
||||
11851 export interface NotebookExecuteHandler {
|
||||
|
||||
11848 */
|
||||
11849: //todo@API inline?
|
||||
11850 export interface NotebookExecuteHandler {
|
||||
11897
|
||||
11898: // todo@api remove
|
||||
11899 /** @deprecated */
|
||||
|
||||
11896
|
||||
11897: // todo@api remove
|
||||
11898 /** @deprecated */
|
||||
11944
|
||||
11945: // todo@API remove
|
||||
11946 /** @deprecated */
|
||||
|
||||
11943
|
||||
11944: // todo@API remove
|
||||
11945 /** @deprecated */
|
||||
11988 */
|
||||
11989: //todo@api selected vs associated, jsdoc
|
||||
11990 readonly onDidChangeNotebookAssociation: Event<{ notebook: NotebookDocument, selected: boolean }>;
|
||||
|
||||
11987 */
|
||||
11988: //todo@api rename to ...NotebookDocument...
|
||||
11989 readonly onDidChangeNotebookAssociation: Event<{ notebook: NotebookDocument, selected: boolean }>;
|
||||
12006
|
||||
12007: // todo@api jsdoc
|
||||
12008: // todo@api Inline unless we can come up with more (future) properties
|
||||
12009 export interface NotebookCellExecuteStartContext {
|
||||
|
||||
12005
|
||||
12006: // todo@api jsdoc
|
||||
12007: // todo@api Inline unless we can come up with more (future) properties
|
||||
12008 export interface NotebookCellExecuteStartContext {
|
||||
12016
|
||||
12017: // todo@api jsdoc
|
||||
12018: // todo@api Inline unless we can come up with more (future) properties
|
||||
12019 export interface NotebookCellExecuteEndContext {
|
||||
|
||||
12015
|
||||
12016: // todo@api jsdoc
|
||||
12017: // todo@api Inline unless we can come up with more (future) properties
|
||||
12018 export interface NotebookCellExecuteEndContext {
|
||||
12061
|
||||
12062: // todo@API inline context object?
|
||||
12063 // @rob inline as arguments
|
||||
|
||||
12060
|
||||
12061: // todo@API inline context object?
|
||||
12062 start(context?: NotebookCellExecuteStartContext): void;
|
||||
12063
|
||||
12064: // todo@API inline context object?
|
||||
12065 end(result?: NotebookCellExecuteEndContext): void;
|
||||
12065
|
||||
12066: // todo@API inline context object?
|
||||
12067 // @rob inline as arguments
|
||||
|
||||
12147 */
|
||||
12148: //todo@API only have Command?
|
||||
12149 command?: string | Command;
|
||||
12176 // @rob
|
||||
12177: // todo@API jsdoc for args
|
||||
12178: // todo@API should ctors only have the args for required properties?
|
||||
12179 constructor(text: string, alignment: NotebookCellStatusBarAlignment, command?: string | Command, tooltip?: string, priority?: number, accessibilityInformation?: AccessibilityInformation);
|
||||
|
||||
12168 */
|
||||
12169: // todo@API jsdoc for args
|
||||
12170: // todo@API should ctors only have the args for required properties?
|
||||
12171 constructor(text: string, alignment: NotebookCellStatusBarAlignment, command?: string | Command, tooltip?: string, priority?: number, accessibilityInformation?: AccessibilityInformation);
|
||||
12196 // @rob
|
||||
12197: //todo@API jsdoc for return-type
|
||||
12198: //todo@API should this return T | T[]
|
||||
12199 provideCellStatusBarItems(cell: NotebookCell, token: CancellationToken): ProviderResult<NotebookCellStatusBarItem[]>;
|
||||
|
||||
12187 */
|
||||
12188: //todo@API jsdoc for return-type
|
||||
12189: //todo@API should this return an item instead of an array?
|
||||
12190 provideCellStatusBarItems(cell: NotebookCell, token: CancellationToken): ProviderResult<NotebookCellStatusBarItem[]>;
|
||||
12210 */
|
||||
12211: // todo@api what should be in this namespace? should notebookDocuments and friends be in the workspace namespace?
|
||||
12212 export namespace notebooks {
|
||||
|
||||
12201 */
|
||||
12202: // todo@api what should be in this namespace? should notebookDocuments and friends be in the workspace namespace?
|
||||
12203 export namespace notebooks {
|
||||
12216 */
|
||||
12217: // todo@api move to workspace
|
||||
12218 export const notebookDocuments: readonly NotebookDocument[];
|
||||
|
||||
12232 */
|
||||
12233: // todo@api move to workspace
|
||||
12234 export function openNotebookDocument(uri: Uri): Thenable<NotebookDocument>;
|
||||
|
||||
12244 */
|
||||
12245: // todo@api move to workspace
|
||||
12246 export function openNotebookDocument(notebookType: string, content?: NotebookData): Thenable<NotebookDocument>;
|
||||
|
||||
12250 */
|
||||
12251: // todo@api move to workspace
|
||||
12252 export const onDidOpenNotebookDocument: Event<NotebookDocument>;
|
||||
|
||||
12261 */
|
||||
12262: // todo@api move to workspace
|
||||
12263 export const onDidCloseNotebookDocument: Event<NotebookDocument>;
|
||||
|
||||
12275 */
|
||||
12276: // todo@api move to workspace
|
||||
12277 export function registerNotebookSerializer(notebookType: string, serializer: NotebookSerializer, options?: NotebookDocumentContentOptions): Disposable;
|
||||
|
|
31
src/vs/vscode.d.ts
vendored
31
src/vs/vscode.d.ts
vendored
|
@ -11456,7 +11456,8 @@ declare module 'vscode' {
|
|||
/**
|
||||
* The unix timestamp at which execution started.
|
||||
*/
|
||||
// todo@API use duration instead of start/end? doesn't allow for only passing one
|
||||
// @rob
|
||||
//todo@API think about invalid state (no end, but start and vice versa)
|
||||
readonly startTime?: number;
|
||||
|
||||
/**
|
||||
|
@ -11635,6 +11636,7 @@ declare module 'vscode' {
|
|||
* @param metadata Optional metadata.
|
||||
*/
|
||||
//todo@API id-args is not used by jupyter but we it added with display_id in mind...
|
||||
// @jupyter check if needed
|
||||
constructor(items: NotebookCellOutputItem[], id: string, metadata?: { [key: string]: any });
|
||||
}
|
||||
|
||||
|
@ -11768,7 +11770,6 @@ declare module 'vscode' {
|
|||
* Controls if a document metadata property change will trigger notebook document content change and if it will be used in the diff editor
|
||||
* Default to false. If the content provider doesn't persisit a metadata property in the file document, it should be set to true.
|
||||
*/
|
||||
// todo@API ...NotebookDocument... or just ...Notebook... just like...Cell... above?
|
||||
transientDocumentMetadata?: { [key: string]: boolean | undefined };
|
||||
}
|
||||
|
||||
|
@ -11782,7 +11783,7 @@ declare module 'vscode' {
|
|||
* @param notebook The notebook for which the execute handler is being called.
|
||||
* @param controller The controller that the handler is attached to
|
||||
*/
|
||||
(this: NotebookController, cells: NotebookCell[], notebook: NotebookDocument, controller: NotebookController): void | Thenable<void>
|
||||
(cells: NotebookCell[], notebook: NotebookDocument, controller: NotebookController): void | Thenable<void>
|
||||
}
|
||||
|
||||
/**
|
||||
|
@ -11907,14 +11908,14 @@ declare module 'vscode' {
|
|||
* _Note_ that supporting {@link NotebookCellExecution.token cancellation tokens} is preferred and that interrupt handlers should
|
||||
* only be used when tokens cannot be supported.
|
||||
*/
|
||||
interruptHandler?: (this: NotebookController, notebook: NotebookDocument) => void | Thenable<void>;
|
||||
interruptHandler?: (notebook: NotebookDocument) => void | Thenable<void>;
|
||||
|
||||
/**
|
||||
* An event that fires whenever a controller has been selected for a notebook document. Selecting a controller
|
||||
* for a notebook is a user gesture and happens either explicitly or implicitly when interacting while a
|
||||
* controller was suggested.
|
||||
*/
|
||||
//todo@api rename to ...NotebookDocument...
|
||||
//todo@api selected vs associated, jsdoc
|
||||
readonly onDidChangeNotebookAssociation: Event<{ notebook: NotebookDocument, selected: boolean }>;
|
||||
|
||||
/**
|
||||
|
@ -11988,9 +11989,11 @@ declare module 'vscode' {
|
|||
executionOrder: number | undefined;
|
||||
|
||||
// todo@API inline context object?
|
||||
// @rob inline as arguments
|
||||
start(context?: NotebookCellExecuteStartContext): void;
|
||||
|
||||
// todo@API inline context object?
|
||||
// @rob inline as arguments
|
||||
end(result?: NotebookCellExecuteEndContext): void;
|
||||
|
||||
/**
|
||||
|
@ -12072,9 +12075,13 @@ declare module 'vscode' {
|
|||
alignment: NotebookCellStatusBarAlignment;
|
||||
|
||||
/**
|
||||
* An optional command to execute when the item is clicked.
|
||||
* An optional {@link Command `Command`} or identifier of a command to run on click.
|
||||
*
|
||||
* The command must be {@link commands.getCommands known}.
|
||||
*
|
||||
* Note that if this is a {@link Command `Command`} object, only the {@link Command.command `command`} and {@link Command.arguments `arguments`}
|
||||
* are used by VS Code.
|
||||
*/
|
||||
//todo@API only have Command?
|
||||
command?: string | Command;
|
||||
|
||||
/**
|
||||
|
@ -12095,6 +12102,7 @@ declare module 'vscode' {
|
|||
/**
|
||||
* Creates a new NotebookCellStatusBarItem.
|
||||
*/
|
||||
// @rob
|
||||
// todo@API jsdoc for args
|
||||
// todo@API should ctors only have the args for required properties?
|
||||
constructor(text: string, alignment: NotebookCellStatusBarAlignment, command?: string | Command, tooltip?: string, priority?: number, accessibilityInformation?: AccessibilityInformation);
|
||||
|
@ -12114,8 +12122,9 @@ declare module 'vscode' {
|
|||
* @param cell The cell for which to return items.
|
||||
* @param token A token triggered if this request should be cancelled.
|
||||
*/
|
||||
// @rob
|
||||
//todo@API jsdoc for return-type
|
||||
//todo@API should this return an item instead of an array?
|
||||
//todo@API should this return T | T[]
|
||||
provideCellStatusBarItems(cell: NotebookCell, token: CancellationToken): ProviderResult<NotebookCellStatusBarItem[]>;
|
||||
}
|
||||
|
||||
|
@ -12134,6 +12143,7 @@ declare module 'vscode' {
|
|||
/**
|
||||
* All notebook documents currently known to the editor.
|
||||
*/
|
||||
// todo@api move to workspace
|
||||
export const notebookDocuments: readonly NotebookDocument[];
|
||||
|
||||
/**
|
||||
|
@ -12149,6 +12159,7 @@ declare module 'vscode' {
|
|||
* @param uri The resource to open.
|
||||
* @returns A promise that resolves to a {@link NotebookDocument notebook}
|
||||
*/
|
||||
// todo@api move to workspace
|
||||
export function openNotebookDocument(uri: Uri): Thenable<NotebookDocument>;
|
||||
|
||||
/**
|
||||
|
@ -12160,11 +12171,13 @@ declare module 'vscode' {
|
|||
* @param content The initial contents of the notebook.
|
||||
* @returns A promise that resolves to a {@link NotebookDocument notebook}.
|
||||
*/
|
||||
// todo@api move to workspace
|
||||
export function openNotebookDocument(notebookType: string, content?: NotebookData): Thenable<NotebookDocument>;
|
||||
|
||||
/**
|
||||
* An event that is emitted when a {@link NotebookDocument notebook} is opened.
|
||||
*/
|
||||
// todo@api move to workspace
|
||||
export const onDidOpenNotebookDocument: Event<NotebookDocument>;
|
||||
|
||||
/**
|
||||
|
@ -12175,6 +12188,7 @@ declare module 'vscode' {
|
|||
* *Note 2:* A notebook can be open but not shown in an editor which means this event can fire
|
||||
* for a notebook that has not been shown in an editor.
|
||||
*/
|
||||
// todo@api move to workspace
|
||||
export const onDidCloseNotebookDocument: Event<NotebookDocument>;
|
||||
|
||||
/**
|
||||
|
@ -12188,6 +12202,7 @@ declare module 'vscode' {
|
|||
* @param options Optional context options that define what parts of a notebook should be persisted
|
||||
* @return A {@link Disposable} that unregisters this serializer when being disposed.
|
||||
*/
|
||||
// todo@api move to workspace
|
||||
export function registerNotebookSerializer(notebookType: string, serializer: NotebookSerializer, options?: NotebookDocumentContentOptions): Disposable;
|
||||
|
||||
/**
|
||||
|
|
Loading…
Reference in a new issue