vdk-jupyter: improve init message #2618
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
duyguHsnHsn
approved these changes
Aug 28, 2023
|
Please, add a sentence that explains this cell should be executed to load job_input. We got it as feedback |
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
antoniivanov
force-pushed
the
person/aivanov/vdk-jupyter-init
branch
from
1b05825 to
ede211e
Compare
Done. 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 |
dakodakov
approved these changes
Aug 29, 2023
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
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: