Skip to content

DOC: Add inline example for filter1d - #4972

Open
AisunZa wants to merge 5 commits into
GenericMappingTools:mainfrom
AisunZa:docs/filter1d-inline-example-1686
Open

AisunZa wants to merge 5 commits into
GenericMappingTools:mainfrom
AisunZa:docs/filter1d-inline-example-1686

Conversation

@AisunZa

@AisunZa AisunZa commented Nov 10, 2026

Copy link
Copy Markdown
Contributor

Description of proposed changes

This PR adds a self-contained usage example to the pygmt.filter1d docstring.

The example demonstrates Gaussian filtering of synthetic time-series data, using the filter_type and end parameters.

It also follows PyGMT's existing doctest conventions.

This is a documentation-only change; no implementation or runtime behavior was modified.

Related issue

Addresses the unchecked filter1d item in #1686.

Testing

  • Reviewed the example against the existing filter1d implementation and tests.
  • Local execution against GMT has not been performed.
  • Awaiting automated CI and documentation checks.

Preview

To be added when the documentation preview is available.

@seisman seisman added this to the 0.21.0 milestone Nov 16, 2026

This branch has not been deployed

No deployments
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants