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

Improve documentation in scatter3d.py gallery example #1064

Merged
merged 6 commits into from
Mar 16, 2021

Conversation

michaelgrund
Copy link
Member

According to the comments and review suggestions in #1006, here's an update for the documentation of the scatter3d gallery example. It now follows the documentation of the recently deployed Color points by categories gallery example.

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

According to the comments and review suggestions in #1006, here's an update for the documentation of the scatter3d gallery example. It now follows the documentation of the recently deployed [Color points by categories]
@michaelgrund michaelgrund marked this pull request as draft March 15, 2021 07:20
@michaelgrund michaelgrund added documentation Improvements or additions to documentation skip-changelog Skip adding Pull Request to changelog labels Mar 15, 2021
examples/gallery/3d_plots/scatter3d.py Outdated Show resolved Hide resolved
examples/gallery/3d_plots/scatter3d.py Outdated Show resolved Hide resolved
@core-man
Copy link
Member

Line 8:

can be visualized using a perspective 3-dimensional plot. The ``region`

We use 3D in other places (e.g., Line 5), so how about 3D instead 3-dimensional here?

Co-authored-by: Yao Jiayuan <coreman.seism@gmail.com>
@michaelgrund
Copy link
Member Author

Line 8:

can be visualized using a perspective 3-dimensional plot. The ``region`

We use 3D in other places (e.g., Line 5), so how about 3D instead 3-dimensional here?

Done in d44950b.

@seisman seisman added this to the 0.4.0 milestone Mar 16, 2021
@seisman seisman requested a review from core-man March 16, 2021 01:00
@seisman seisman marked this pull request as ready for review March 16, 2021 01:00
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.

Just two small typos, otherwise looks good to me!

examples/gallery/3d_plots/scatter3d.py Outdated Show resolved Hide resolved
examples/gallery/3d_plots/scatter3d.py Outdated Show resolved Hide resolved
@core-man
Copy link
Member

Looks great.

Co-authored-by: Wei Ji <23487320+weiji14@users.noreply.github.com>
@seisman seisman merged commit 3d64fc1 into master Mar 16, 2021
@seisman seisman deleted the improve-3dscatter-gallery branch March 16, 2021 05:16
sixy6e pushed a commit to sixy6e/pygmt that referenced this pull request Dec 21, 2022
…Tools#1064)

Co-authored-by: Yao Jiayuan <coreman.seism@gmail.com>
Co-authored-by: Wei Ji <23487320+weiji14@users.noreply.github.com>
Co-authored-by: Dongdong Tian <seisman.info@gmail.com>
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.

4 participants