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

Rename tutorials using underscores #1041

Closed
wants to merge 3 commits into from
Closed

Conversation

maxrjones
Copy link
Member

Description of proposed changes

This PR renames tutorials with underscores, rather than dashes.

Fixes #1039

Reminders

  • Run make format and make check to make sure the code follows the style guide.
  • Add tests for new features or tests that would have caught the bug that you're fixing.
  • Add new public functions/methods/classes to doc/api/index.rst.
  • Write detailed docstrings for all functions/methods.
  • If adding new functionality, add an example to docstrings or tutorials.

Slash Commands

You can write slash commands (/command) in the first line of a comment to perform
specific operations. Supported slash commands are:

  • /format: automatically format and lint the code
  • /test-gmt-dev: run full tests on the latest GMT development version

@seisman
Copy link
Member

seisman commented Mar 12, 2021

/home/runner/work/pygmt/pygmt/doc/index.rst:16: WARNING: toctree contains reference to nonexisting document 'tutorials/first-figure'
looking for now-outdated files... none found
/home/runner/work/pygmt/pygmt/doc/index.rst:26: WARNING: toctree contains reference to nonexisting document 'tutorials/contour-map'
/home/runner/work/pygmt/pygmt/doc/index.rst:26: WARNING: toctree contains reference to nonexisting document 'tutorials/earth-relief'
/home/runner/work/pygmt/pygmt/doc/index.rst:26: WARNING: toctree contains reference to nonexisting document 'tutorials/3d-perspective-image'

Need to update the file doc/index.rst.

@seisman seisman added this to the 0.3.1 milestone Mar 12, 2021
@seisman seisman added documentation Improvements or additions to documentation skip-changelog Skip adding Pull Request to changelog labels Mar 12, 2021
@maxrjones
Copy link
Member Author

/home/runner/work/pygmt/pygmt/doc/index.rst:16: WARNING: toctree contains reference to nonexisting document 'tutorials/first-figure'
looking for now-outdated files... none found
/home/runner/work/pygmt/pygmt/doc/index.rst:26: WARNING: toctree contains reference to nonexisting document 'tutorials/contour-map'
/home/runner/work/pygmt/pygmt/doc/index.rst:26: WARNING: toctree contains reference to nonexisting document 'tutorials/earth-relief'
/home/runner/work/pygmt/pygmt/doc/index.rst:26: WARNING: toctree contains reference to nonexisting document 'tutorials/3d-perspective-image'

Need to update the file doc/index.rst.

Thanks, fixed in ef0d43e

@seisman
Copy link
Member

seisman commented Mar 12, 2021

There may be something wrong with GitHub.

I clicked the "Squash and merge" button a few minutes ago and it froze.

Now it seems the changes in this PR are already in the master branch, but this PR is still unmerged. Is this what you're seeing?

@maxrjones
Copy link
Member Author

There may be something wrong with GitHub.

I clicked the "Squash and merge" button a few minutes ago and it froze.

Now it seems the changes in this PR are already in the master branch, but this PR is still unmerged. Is this what you're seeing?

Yes, I see the same thing. The commit log shows this as merged, but the PR does not reflect that.

@michaelgrund
Copy link
Member

There may be something wrong with GitHub.
I clicked the "Squash and merge" button a few minutes ago and it froze.
Now it seems the changes in this PR are already in the master branch, but this PR is still unmerged. Is this what you're seeing?

Yes, I see the same thing. The commit log shows this as merged, but the PR does not reflect that.

I see the same.

@seisman
Copy link
Member

seisman commented Mar 12, 2021

Maybe GitHub did the "git merge" command, froze and then forgot to close the PR.

Let's keep this PR open for a while and see if anything changes.

@weiji14
Copy link
Member

weiji14 commented Mar 12, 2021

https://www.githubstatus.com/. Parts of GitHub are currently down. Need to wait it out and be careful for a while.

pull bot pushed a commit to aliciaha1997/pygmt that referenced this pull request Mar 12, 2021
@seisman
Copy link
Member

seisman commented Mar 12, 2021

GitHub is up now. Nothing changes. I'll close the PR.

@seisman seisman closed this Mar 12, 2021
@seisman seisman deleted the tutorials-underscores branch March 12, 2021 20:09
sixy6e pushed a commit to sixy6e/pygmt that referenced this pull request Dec 21, 2022
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.

Rename files in the tutorials using underscores
4 participants