Docs: typos and grammar in docstrings

Open Beginner friendly
#718 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
2/5
Estimated time
1-3 hours
Newbie friendliness
72/100
Issue type
Documentation
Clarity
Mostly clear
Activity status
Active
Tech stack
python
Domain
documentation

Research direction

Find the docstrings for GeoSeries.map, MultipleGeoSeries.map, Series.summary_plot, and Series.correlation; the issue identifies these methods but not their file paths. Check the actual defaults for both map methods before correcting the contradictory text, then fix the listed typos and grammar. Done when all listed docstrings are corrected and the default descriptions match the code.

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.

  • Overriden → overridden: GeoSeries.map, MultipleGeoSeries.map, Series.summary_plot
  • Defaults is → Default is: GeoSeries.map, MultipleGeoSeries.map
  • signficance → significance: Series.correlation

Not in the checklist but on the same lines: GeoSeries.map and MultipleGeoSeries.map say Default is off (True), which contradicts itself. Check the actual default and fix the text.

Related: #669 (list of available projections) also edits the GeoSeries.map / MultipleGeoSeries.map docstrings.

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.