Skip to content

Commit

Permalink
Update comments in API (#14700)
Browse files Browse the repository at this point in the history
  • Loading branch information
DonJayamanne authored Nov 10, 2023
1 parent 017fdab commit c850abd
Show file tree
Hide file tree
Showing 2 changed files with 4 additions and 3 deletions.
3 changes: 3 additions & 0 deletions src/api.proposed.kernelApi.d.ts
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,9 @@
import type { Event, Uri } from 'vscode';

declare module './api' {
/**
* Represents a Jupyter Kernel.
*/
export interface Kernel {}
export interface Kernels {
/**
Expand Down
4 changes: 1 addition & 3 deletions src/api.proposed.kernelCodeExecution.d.ts
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down

0 comments on commit c850abd

Please sign in to comment.