Skip to content

Commit e3442ce

Browse files
authored
vdk-jupyter: improve init message (#2618)
It's better not to provide link to git repo source code. Links to source code are not best documentation. But also job_input could be changed through plugins in which case it won't be accurate. Notebook `help(xxx)` is much more suitable. Remove the unnecesary warning. it's not critical and even if by mistake they mark the current cell , they'd quickly find out t problem when using vdk run I also made the cell non-editable. During user testing, users were trying to edit it and this may cause potential issues as it's not expected output of help(job_input) looks like that: ![image](https://github.com/vmware/versatile-data-kit/assets/2536458/5edac2d8-c32b-469e-9ed2-84cb4c72827c)
1 parent e1bb698 commit e3442ce

File tree

2 files changed

+4
-5
lines changed

2 files changed

+4
-5
lines changed

.gitignore

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -18,6 +18,7 @@ out
1818
build
1919
dist
2020
src/*.egg-info
21+
.yarn
2122

2223
# Project files
2324
.ropeproject

projects/vdk-plugins/vdk-jupyter/vdk-jupyterlab-extension/src/initVDKConfigCell.ts

Lines changed: 3 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -17,22 +17,20 @@ export function initVDKConfigCell(notebookTracker: INotebookTracker) {
1717
cell_type: 'code',
1818
source: [
1919
`"""\n`,
20+
`This cell must be executed to load VDK job_input variable .\n\n`,
2021
`vdk.plugin.ipython extension introduces a magic command for Jupyter.\n`,
2122
`The command enables the user to load VDK for the current notebook.\n`,
2223
`VDK provides the job_input API, which has methods for:\n`,
2324
` * executing queries to an OLAP database;\n`,
2425
` * ingesting data into a database;\n`,
2526
` * processing data into a database.\n`,
26-
`See the IJobInput documentation for more details.\n`,
27-
`https://github.com/vmware/versatile-data-kit/blob/main/projects/vdk-core/src/vdk/api/job_input.py\n`,
28-
`Please refrain from tagging this cell with VDK as it is not an actual part of the data job\n`,
29-
`and is only used for development purposes.\n`,
27+
`Type help(job_input) to see its documentation.\n`,
3028
`"""\n`,
3129
`%reload_ext vdk.plugin.ipython\n`,
3230
`%reload_VDK\n`,
3331
`job_input = VDK.get_initialized_job_input()`
3432
],
35-
metadata: {}
33+
metadata: { editable: false }
3634
}
3735
});
3836
const cells = notebookTracker.currentWidget?.content.model?.cells;

0 commit comments

Comments
 (0)