Skip to content

Fix two sphinx warnings for docs build #1285

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.

Sign up for GitHub

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

Jump to bottom
Merged
merged 4 commits into from
May 23, 2021
Merged

Fix two sphinx warnings for docs build #1285

merged 4 commits into from
May 23, 2021

Conversation

@maxrjones
Copy link
Member

@maxrjones maxrjones commented May 22, 2021

Description of proposed changes

This PR fixes two warnings generated when building the docs:

pygmt/pygmt/src/wiggle.py:docstring of pygmt.src.wiggle.wiggle:54: WARNING: Inline substitution_reference start-string without end-string.
pygmt/pygmt/clib/session.py:docstring of pygmt.clib.session.Session.put_vector:9: WARNING: Unknown target name: "str".

Fixes #

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

@maxrjones maxrjones added the skip-changelog Skip adding Pull Request to changelog label May 22, 2021
seisman
seisman reviewed May 22, 2021
View reviewed changes
@seisman seisman added this to the 0.4.0 milestone May 23, 2021
@seisman seisman added documentation Improvements or additions to documentation final review call This PR requires final review and approval from a second reviewer labels May 23, 2021
core-man
core-man approved these changes May 23, 2021
View reviewed changes
Copy link
Member

@core-man core-man left a comment

Choose a reason for hiding this comment

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

Great~

michaelgrund
michaelgrund approved these changes May 23, 2021
View reviewed changes
Copy link
Member

@michaelgrund michaelgrund left a comment

Choose a reason for hiding this comment

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

Looks good!

@weiji14 weiji14 merged commit b28448b into master May 23, 2021
@weiji14 weiji14 deleted the fix-sphinx-warnings branch May 23, 2021 23:43
@weiji14 weiji14 removed the final review call This PR requires final review and approval from a second reviewer label May 23, 2021
sixy6e pushed a commit to sixy6e/pygmt that referenced this pull request Dec 21, 2022
Fix two sphinx warnings for docs build (GenericMappingTools#1285)
cfa5fa3 
Specifically in pygmt/src/wiggle.py and pygmt/clib/session.py
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@seisman seisman seisman approved these changes

@michaelgrund michaelgrund michaelgrund approved these changes

@weiji14 weiji14 weiji14 approved these changes

@core-man core-man core-man approved these changes

Assignees

No one assigned

Labels

documentation Improvements or additions to documentation skip-changelog Skip adding Pull Request to changelog

Projects

None yet

Milestone

0.4.0

Development

Successfully merging this pull request may close these issues.

6 participants

@maxrjones @seisman @michaelgrund @weiji14 @core-man