Docs: typos and grammar in docstrings
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
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
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
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
More from LinkedEarth/Pyleoclim_util
-
documentation
Difficulty 2/5 1-3 hours Newbie friendliness 68/100
LinkedEarth/Pyleoclim_util#717 ·
-
documentation
Difficulty 2/5 1-3 hours Newbie friendliness 75/100
LinkedEarth/Pyleoclim_util#716 ·
-
documentation
Difficulty 2/5 1-3 hours Newbie friendliness 85/100
LinkedEarth/Pyleoclim_util#715 ·
-
Broken doc linkOpendocumentation help wanted
Difficulty 2/5 1-3 hours Newbie friendliness 70/100
LinkedEarth/Pyleoclim_util#704 ·
-
documentation
Difficulty 4/5 3-5 days Newbie friendliness 48/100
LinkedEarth/Pyleoclim_util#721 ·
All issues in LinkedEarth/Pyleoclim_util
Similar issues
-
5-minutes algorithm all-levels any-language beginner-friendly community documentation easy first-timers-only good first issue hacktoberfest help wanted learning no-code-needed open-source python students
Difficulty 2/5 1-3 hours Newbie friendliness 78/100
Huerte/algo-solutions-python#281 ·
Maintainers usually reply within 1 day
-
Difficulty 2/5 1-3 hours Newbie friendliness 84/100
apache/flink-agents#1395 ·
Maintainers usually reply within 1 day
-
Difficulty 2/5 1-3 hours Newbie friendliness 88/100
pybamm-team/PyBaMM#6061 ·
Maintainers usually reply within 2 days
-
A wall-clock ceiling in test_rest_import_off_the_loop turns the gate red on unrelated pull requestsOpenbug help wanted quality
Difficulty 2/5 1-3 hours Newbie friendliness 88/100
pyrite-wiki/pyrite#1550 ·
Maintainers usually reply within 1 day
-
Difficulty 2/5 1-3 hours Newbie friendliness 72/100
daniel-ospina/tortoise#13049 ·
Maintainers usually reply within 1 day