Skip to content

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

Closed

Description

@leouieda

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

Activity

  1. willschlitzer commented on Jan 26, 2021

    @willschlitzer
    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?

  2. seisman commented on Jan 26, 2021

    @seisman
    Member

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

  3. willschlitzer commented on Jan 26, 2021

    @willschlitzer
    Contributor

    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.

  4. seisman commented on Jan 26, 2021

    @seisman
    Member

    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.

  5. linked a pull request that will close this issueTutorial notebook explanation #806on Jan 26, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    documentationImprovements or additions to documentationgood first issueGood for newcomershelp wantedHelping hands are appreciated

    Type

    No type

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions