-
Notifications
You must be signed in to change notification settings - Fork 10
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
docs: clarify tutorials usage #620
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Good addition. This clarifies that users should use the system we provide.
I do think we can be less explicit about what goes wrong if they don't (as per my suggestion below).
Also, should this PR point to dev instead of main? or is that not needed if it's just docs changes? It looks like it was branched off of dev, but now points to main.
Co-authored-by: Dani Bodor <[email protected]>
…hub.com/DeepRank/deeprank2 into 609_inspect_source_code_clarify_gcroci2
I accepted your suggestion and I removed the section's title (thinking about it the note is enough)
Indeed, moved to dev :) |
I added a disclaimer in the tutorials' readme to make user that users know that they are not supposed to run the notebooks' code into python interactive shell.