pygmt

pygmt copied to clipboard

**Description of proposed changes** So that we can remove the setup.cfg file and have everything in pyproject.toml! Flakeheaven (https://github.com/flakeheaven/flakeheaven) is a flake8 wrapper/fork that is supports configuration in `pyproject.toml`. For...

weiji14

Use longname placeholders in the docstrings for common options

1

**Description of proposed changes** For "common" options, we have the option description defined in the file [`pygmt/helpers/decorators.py`](https://github.com/GenericMappingTools/pygmt/blob/c70fe880335c1ace9d9fab6ec67d31896edea117/pygmt/helpers/decorators.py#L17). Then in the module wrappers, we can use placeholders like `{R}` in the...

seisman

**Description of the desired feature** For 3D plots, it should be possible to plot text at different heights based on a 'z' column, see https://docs.generic-mapping-tools.org/6.2/text.html#z. The current implementation of `text`...

weiji14

Currently, the instructions say: > This should be set to the directory where libgmt.so, libgmt.dylib or gmt.dll can be found for Linux, macOS and Windows, respectively. e.g., on a command...

seisman

Remove GMT binary path and version from pygmt.show_versions()

3

**Description of proposed changes** 1. Show the GMT binary version available from the API parameter `API_BIN_VERSION`. 2. Don't show the GMT version by calling `gmt --version` 3. Don't show GMT's...

seisman

**Description of proposed changes** This PR adds an inline example for pygmt.datasets.list_sample_data. It is a possible solution to https://github.com/GenericMappingTools/pygmt/issues/1774 and would be easier to maintain than table/list in the docstring...

maxrjones

We have the `list_sample_data` function to list all sample data that are available in `load_sample_data`. However, the documentation of [list_sample_data](https://www.pygmt.org/dev/api/generated/pygmt.datasets.list_sample_data.html#pygmt.datasets.list_sample_data) and [`load_sample_data`](https://www.pygmt.org/dev/api/generated/pygmt.datasets.load_sample_data.html#pygmt.datasets.load_sample_data) say nothing, so users have to call the...

seisman

**Description of the desired feature** The authorship policy added in https://github.com/GenericMappingTools/pygmt/pull/726 is really helpful to have for releases and future papers. I found it a bit more confusing how authorship...

maxrjones

Add inline code examples in data processing module docstrings

13

As first discussed in [this comment](https://github.com/GenericMappingTools/pygmt/issues/1666#issuecomment-993962742), module docstrings should contain inline code examples to show a working example of the module with the correct syntax without needing to find an...

willschlitzer

Missing Examples for user facing function

4

**Description of the desired feature** First of all, the existing examples are really, really nice! They helped me a lot understanding the functionality. I was however not able to find...

jbusecke