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

Tutorial notebook explanation #806

Conversation

willschlitzer
Copy link
Contributor

@willschlitzer willschlitzer commented Jan 26, 2021

As discussed in #182, this is to update the doc strings for the tutorials to state they assume the use of a Python notebook, how to modify the code to use a Pythons script, and how to save figures. These lines should be removed once #529 is merged.

@willschlitzer willschlitzer added this to the 0.3.0 milestone Jan 26, 2021
@willschlitzer willschlitzer added the documentation Improvements or additions to documentation label Jan 26, 2021
@willschlitzer
Copy link
Contributor Author

willschlitzer commented Jan 26, 2021

@seisman Not sure if I messed up the fetch/force push, but I'm still seeing all of the old commits in this PR.

@willschlitzer
Copy link
Contributor Author

@GenericMappingTools/python-maintainers Do we think the explanation lines for using a notebook should be on all gallery examples as well? I think tutorials are sufficient, but I can add it in galleries as well.

@willschlitzer willschlitzer marked this pull request as ready for review January 27, 2021 11:50
@willschlitzer
Copy link
Contributor Author

@GenericMappingTools/python Could I get a review/feedback for this pull request? I'm hoping to get it in for the documentation on v0.3.

@weiji14
Copy link
Member

weiji14 commented Feb 10, 2021

Is there a way to insert a common block of text in multiple tutorial pages? Better than copying and pasting so much text around everytime we make a change.

@willschlitzer
Copy link
Contributor Author

Is there a way to insert a common block of text in multiple tutorial pages? Better than copying and pasting so much text around everytime we make a change.

I think this is a good idea, but I don't think we'll be able to get it done before v0.3, so I would rather have this note in here as is, for now, rather than no note at all.

@seisman
Copy link
Member

seisman commented Feb 10, 2021

Is there a way to insert a common block of text in multiple tutorial pages? Better than copying and pasting so much text around everytime we make a change.

It's a good idea. I tried to explore the possible ways but didn't find one. As we will delete these notes after we finish #529, I feel that the current PR is the simplest solution.

Copy link
Member

@weiji14 weiji14 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Ok. Since it's temporary let's go with it. But one small comment.

examples/tutorials/3d-perspective-image.py Show resolved Hide resolved
Copy link
Member

@weiji14 weiji14 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Feel free to merge :)

@seisman seisman added the skip-changelog Skip adding Pull Request to changelog label Feb 11, 2021
@willschlitzer willschlitzer merged commit 394c847 into GenericMappingTools:master Feb 11, 2021
@willschlitzer willschlitzer deleted the tutorial-notebook-explanation branch February 12, 2021 07:05
sixy6e pushed a commit to sixy6e/pygmt that referenced this pull request Dec 21, 2022
*Add a note in all tutorial examples to explain the use of a Python notebook

Co-authored-by: Dongdong Tian <[email protected]>
Co-authored-by: Wei Ji <[email protected]>
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 skip-changelog Skip adding Pull Request to changelog
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Make it clear in the tutorials that they assume that you're using a notebook
3 participants