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

Make it clear in the tutorials that they assume that you're using a notebook #182

Closed
leouieda opened this issue May 24, 2018 · 4 comments · Fixed by #806
Closed

Make it clear in the tutorials that they assume that you're using a notebook #182

leouieda opened this issue May 24, 2018 · 4 comments · Fixed by #806
Labels
documentation Improvements or additions to documentation good first issue Good for newcomers help wanted Helping hands are appreciated

Comments

@leouieda
Copy link
Member

The tutorials all assume that the user is running Jupyter with the many fig.show() calls. There should be a warning in the beginning of each tutorial stating that this works on notebooks and giving options for the terminal prompt (fig.show(external=True)) and in scripts fig.savefig('figname.pdf', show=True).

@leouieda leouieda added good first issue Good for newcomers documentation Improvements or additions to documentation help wanted Helping hands are appreciated labels May 24, 2018
@willschlitzer
Copy link
Contributor

@GenericMappingTools/python Is this something we still want, and if so, should it be in the doc strings/lead section of every tutorial and gallery example?

@seisman
Copy link
Member

seisman commented Jan 26, 2021

The issue will become invalid after #529 is merged. That PR is almost working, however, I haven't found much time to finish it.

@willschlitzer
Copy link
Contributor

willschlitzer commented Jan 26, 2021

Sounds good. Do you think it will be done before the v0.3 release? I'm not trying to hurry you, but I think if it's won't be completed in time then the tutorials should at least be updated for the next release, and then removed once your pull request is merged. I can submit a PR for this if it looks like it's the case that it won't be ready in time.

@seisman
Copy link
Member

seisman commented Jan 26, 2021

Do you think it will be done before the v0.3 release?

Not sure if I can find some time before v0.3 release.

I can submit a PR for this if it looks like it's the case that it won't be ready in time.

Go ahead, please.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation good first issue Good for newcomers help wanted Helping hands are appreciated
Projects
None yet
Development

Successfully merging a pull request may close this issue.

3 participants