Improve grammar and fix typos in a notebook api

This commit is contained in:
Daniel Imms
2022-02-03 09:42:18 -08:00
parent b46986a65f
commit aad33b60cc

View File

@@ -12441,21 +12441,26 @@ declare module 'vscode' {
*/
export interface NotebookDocumentContentOptions {
/**
* Controls if outputs 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 the outputs in the file document, this should be set to true.
* Controls if output change events will trigger notebook document content change events and
* if it will be used in the diff editor, defaults to false. If the content provider doesn't
* persist the outputs in the file document, this should be set to true.
*/
transientOutputs?: boolean;
/**
* Controls if a cell 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.
* Controls if a cell metadata property change event will trigger notebook document content
* change events and if it will be used in the diff editor, defaults to false. If the
* content provider doesn't persist a metadata property in the file document, it should be
* set to true.
*/
transientCellMetadata?: { [key: string]: boolean | undefined };
/**
* 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.
*/
* Controls if a document metadata property change event will trigger notebook document
* content change event and if it will be used in the diff editor, defaults to false. If the
* content provider doesn't persist a metadata property in the file document, it should be
* set to true.
*/
transientDocumentMetadata?: { [key: string]: boolean | undefined };
}