Skip to content
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

Merged
merged 4 commits into from
Jul 5, 2024
Merged

Conversation

gcroci2
Copy link
Collaborator

@gcroci2 gcroci2 commented Jul 1, 2024

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
@coveralls
Copy link

Coverage Status

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

Copy link
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.

tutorials/TUTORIAL.md Outdated Show resolved Hide resolved
tutorials/TUTORIAL.md Outdated Show resolved Hide resolved
@gcroci2 gcroci2 changed the base branch from main to dev July 5, 2024 15:48
@gcroci2
Copy link
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
2 checks passed
@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
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Bug: OSError: could not get source code
3 participants