Skip to content

docs: clarify tutorials usage#620

Merged
gcroci2 merged 4 commits intodevfrom
609_inspect_source_code_clarify_gcroci2
Jul 5, 2024
Merged

docs: clarify tutorials usage#620
gcroci2 merged 4 commits intodevfrom
609_inspect_source_code_clarify_gcroci2

Conversation

@gcroci2
Copy link
Copy Markdown
Collaborator

@gcroci2 gcroci2 commented Jul 1, 2024 •
edited
Loading

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.

@gcroci2 gcroci2 requested a review from DaniBodor July 1, 2024 11:20
@gcroci2 gcroci2 self-assigned this Jul 1, 2024
@gcroci2 gcroci2 linked an issue Jul 1, 2024 that may be closed by this pull request
Bug: OSError: could not get source code #609
Closed
@gcroci2 gcroci2 mentioned this pull request Jul 1, 2024
Closed
@coveralls
Copy link
Copy Markdown

coveralls commented Jul 1, 2024

Coverage Status

coverage: 83.933%. remained the same
when pulling 58311f9 on 609_inspect_source_code_clarify_gcroci2
into 0461556 on main.

DaniBodor
DaniBodor approved these changes Jul 5, 2024
View reviewed changes
Copy link
Copy Markdown
Collaborator

@DaniBodor DaniBodor left a 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.

@gcroci2 gcroci2 changed the base branch from main to dev July 5, 2024 15:48
gcroci2 and others added 3 commits July 5, 2024 17:49
@gcroci2
Update tutorials/TUTORIAL.md
aa1b237 
Co-authored-by: Dani Bodor <d.bodor@esciencecenter.nl>
@gcroci2
remove emphasis
8adc678
@gcroci2
Merge branch '609_inspect_source_code_clarify_gcroci2' of https://git…
ea9adc1 
…hub.com/DeepRank/deeprank2 into 609_inspect_source_code_clarify_gcroci2
@gcroci2
Copy link
Copy Markdown
Collaborator Author

gcroci2 commented Jul 5, 2024

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).

I accepted your suggestion and I removed the section's title (thinking about it the note is enough)

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.

Indeed, moved to dev :)

@gcroci2 gcroci2 merged commit d64ebf1 into dev Jul 5, 2024
@gcroci2 gcroci2 deleted the 609_inspect_source_code_clarify_gcroci2 branch July 5, 2024 15:53
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@DaniBodor DaniBodor DaniBodor approved these changes

Assignees

@gcroci2 gcroci2

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

Bug: OSError: could not get source code

3 participants

@gcroci2 @coveralls @DaniBodor