Docs: missing or generic Parameters / Returns sections

Open
#720 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
4/5
Estimated time
3-5 days
Newbie friendliness
57/100
Issue type
Documentation
Clarity
Mostly clear
Activity status
Active
Tech stack
python
Domain
documentation

Research direction

The issue lists the affected methods and classes, and points to the checklist docstring_todos_20260312.md in parent issue #689; start by reading that checklist and the listed docstrings. Update missing or generic Parameters and Returns sections, and add Parameters, Returns, and Examples for GeoSeriesResampler and SeriesResampler. Done when each listed item has accurate documentation of its parameters and return values, with examples for those two classes.

Written by the indexing model from the issue text.

Description

documentation

Part of #689 (checklist docstring_todos_20260312.md). Line numbers in that checklist have drifted, so items are listed by method.

Returns section uses a generic res entry; name and describe the actual return values

  • GeoSeries.map, GeoSeries.map_neighbors, GeoSeries.segment
  • MultipleGeoSeries.pca, MultipleSeries.pca
  • Series.stats, Series.ssa, Series.is_evenly_spaced, Series.segment, Series.causality

Missing Returns section

  • CorrEns.plot
  • EnsembleSeries.histplot
  • MultipleSeries.convert_time_unit, Series.convert_time_unit
  • MultivariateDecomp.screeplot
  • Resolution.histplot
  • Series.histplot, Series.summary_plot
  • SsaRes.screeplot, SsaRes.modeplot

Missing Parameters section

  • MultipleSeries.resolution
  • Series.gaussianize

Classes missing Parameters, Returns and Examples

  • GeoSeriesResampler, SeriesResampler
Dominant language
Python
Stars
104
Forks
36
Avg merge
1d 7h
Merged PRs (30d)
5

Getting set up

Open in Codespaces

Starts the project's dev container in your browser, under your own GitHub account.

  • No Dockerfile or Docker Compose file
  • No pull request template
  • No contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from LinkedEarth/Pyleoclim_util

All issues in LinkedEarth/Pyleoclim_util

Similar issues

More Python issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.