From c850abd331a6f866e6e39862d0a1f97b6c3e107d Mon Sep 17 00:00:00 2001 From: Don Jayamanne Date: Fri, 10 Nov 2023 15:42:25 +1100 Subject: [PATCH] Update comments in API (#14700) --- src/api.proposed.kernelApi.d.ts | 3 +++ src/api.proposed.kernelCodeExecution.d.ts | 4 +--- 2 files changed, 4 insertions(+), 3 deletions(-) diff --git a/src/api.proposed.kernelApi.d.ts b/src/api.proposed.kernelApi.d.ts index 9d966a127d9..d7085f73e3d 100644 --- a/src/api.proposed.kernelApi.d.ts +++ b/src/api.proposed.kernelApi.d.ts @@ -4,6 +4,9 @@ import type { Event, Uri } from 'vscode'; declare module './api' { + /** + * Represents a Jupyter Kernel. + */ export interface Kernel {} export interface Kernels { /** diff --git a/src/api.proposed.kernelCodeExecution.d.ts b/src/api.proposed.kernelCodeExecution.d.ts index 04ca5a4f2a7..632b501e9c9 100644 --- a/src/api.proposed.kernelCodeExecution.d.ts +++ b/src/api.proposed.kernelCodeExecution.d.ts @@ -16,9 +16,7 @@ declare module './api' { } export interface Kernel { /** - * Executes code in the kernel. - * The code executed will not result in changes to the execution count - * & will not show up in the Kernel execution history. + * Executes code in the kernel without affecting the execution count & execution history. * * @param code Code to be executed. * @param token Triggers the cancellation of the execution.