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

External Resources: Add repository "gmt-pygmt-plotting" #3213

Merged
merged 4 commits into from
Apr 30, 2024

Conversation

yvonnefroehlich
Copy link
Member

@yvonnefroehlich yvonnefroehlich commented Apr 29, 2024

Description of proposed changes

This PR adds the repository gmt-pygmt-plotting to the external resources page. (Some folders are missing. These Jupyter notebooks or Python scripts will be uploaded up on acceptance of the related publication.)

Currently, I am not 100% sure about the link to the image. For the other entries, the links are significantly shorter and of the form https://user-images.githubusercontent.com/* instead of https://private-user-images.githubusercontent.com/*.

Preview: https://pygmt-dev--3213.org.readthedocs.build/en/3213/external_resources.html#examples-from-publications-and-posters

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 wrapping a new module, open a 'Wrap new GMT module' issue and submit reasonably-sized PRs.
  • If adding new functionality, add an example to docstrings or tutorials.
  • Use underscores (not hyphens) in names of Python files and directories.

Slash Commands

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

  • /format: automatically format and lint the code

@yvonnefroehlich yvonnefroehlich added documentation Improvements or additions to documentation enhancement Improving an existing feature labels Apr 29, 2024
@yvonnefroehlich yvonnefroehlich self-assigned this Apr 29, 2024
@seisman
Copy link
Member

seisman commented Apr 29, 2024

it's likely because the image was uploaded in a private repository. maybe try drag the image to the comment box of this PR.

@seisman seisman added this to the 0.12.0 milestone Apr 30, 2024
@seisman seisman removed the enhancement Improving an existing feature label Apr 30, 2024
@yvonnefroehlich
Copy link
Member Author

it's likely because the image was uploaded in a private repository. maybe try drag the image to the comment box of this PR.

Thanks! I tried this:

github_maps_readme_main

But it is still a link in the form of https://private-user-images.githubusercontent.com/* created. Anyway, for now, I created a folder with all the images for the READMEs and added this link. This seems to work 🙂.

@michaelgrund michaelgrund changed the title External resources: Add repro "gmt-pygmt-plotting" External resources: Add repo "gmt-pygmt-plotting" Apr 30, 2024
@michaelgrund
Copy link
Member

I adjusted the PR title, it's called repo (for repository) not repro.

@seisman seisman merged commit a43a8c7 into main Apr 30, 2024
9 checks passed
@seisman seisman deleted the add-repro-to-external-resources branch April 30, 2024 15:11
@yvonnefroehlich yvonnefroehlich changed the title External resources: Add repo "gmt-pygmt-plotting" External Resources: Add repo "gmt-pygmt-plotting" Apr 30, 2024
@yvonnefroehlich yvonnefroehlich changed the title External Resources: Add repo "gmt-pygmt-plotting" External Resources: Add repository "gmt-pygmt-plotting" Apr 30, 2024
@yvonnefroehlich
Copy link
Member Author

I adjusted the PR title, it's called repo (for repository) not repro.

Thanks for spotting the typo 🙂!
Actually I changed it now to "repository" as is sounds / looks better in the Changelog.

@yvonnefroehlich yvonnefroehlich mentioned this pull request Apr 30, 2024
9 tasks
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
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants