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

Merged
merged 4 commits into from
May 23, 2021
Merged

Fix two sphinx warnings for docs build #1285

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
5fa0abb
Fix sphinx warnings for docs build
May 22, 2021
d027b83
Update fix
May 22, 2021
704b6b3
Update fix
May 22, 2021
53d9318
Make raw docstring
May 22, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions pygmt/clib/session.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -734,7 +734,7 @@ def _check_dtype_and_dim(self, array, ndim):
return self[DTYPES[array.dtype.type]]

def put_vector(self, dataset, column, vector):
"""
r"""
Attach a numpy 1D array as a column on a GMT dataset.

Use this function to attach numpy array data to a GMT dataset and pass
Expand All @@ -744,7 +744,7 @@ def put_vector(self, dataset, column, vector):
first. Use ``family='GMT_IS_DATASET|GMT_VIA_VECTOR'``.

Not at all numpy dtypes are supported, only: float64, float32, int64,
int32, uint64, uint32, datetime64 and str_.
int32, uint64, uint32, datetime64 and str\_.

.. warning::
The numpy array must be C contiguous in memory. If it comes from a
Expand Down
2 changes: 1 addition & 1 deletion pygmt/src/wiggle.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -56,7 +56,7 @@ def wiggle(self, x=None, y=None, z=None, data=None, **kwargs):
{B}
position : str
[**g**\|\ **j**\|\ **J**\|\ **n**\|\ **x**]\ *refpoint*\
**+w**\ *length*\ [**+j**\ *justify*]\ [**+al**\ |\ **r**]\
**+w**\ *length*\ [**+j**\ *justify*]\ [**+al**\|\ **r**]\
[**+o**\ *dx*\ [/*dy*]][**+l**\ [*label*]].
Defines the reference point on the map for the vertical scale bar.
color : str
Expand Down