Conversation
arnavsharma990
commented
Feb 20, 2026
arnavsharma990
commented
- Fix typos in README.md: 'it easiest' -> 'it is easiest', 'handelled' -> 'handled', 'distrubted' -> 'distributed', 'varable' -> 'variable', 'gaurantee' -> 'guarantee'
- Fix typo in CHANGELOG.md: 'ouput' -> 'output'
- Fix CHANGELOG link text: '\25' -> 'add cli access #25' for PR add cli access #25
- Fix TODO comment typos in mapping.py: 'involved' -> 'involve', 'xrarrays' -> 'xarray's', 'lets' -> 'let's'
- Fix docstring formatting: normalize Returns section underline in subsetting.py
- Add missing Parameters/Returns sections to check_point_in_dataset and check_step
- Fix incorrect Returns docstring in check_chunk_size (doesn't return ds)
- Fix docstring parameter mismatch in map_dims_and_variables (remove incorrect arch_dim parameter)
- Add Returns section to validate_config docstring
- Fix typos in README.md: 'it easiest' -> 'it is easiest', 'handelled' -> 'handled', 'distrubted' -> 'distributed', 'varable' -> 'variable', 'gaurantee' -> 'guarantee' - Fix typo in CHANGELOG.md: 'ouput' -> 'output' - Fix CHANGELOG link text: '\25' -> '\mllam#25' for PR mllam#25 - Fix TODO comment typos in mapping.py: 'involved' -> 'involve', 'xrarrays' -> 'xarray's', 'lets' -> 'let's' - Fix docstring formatting: normalize Returns section underline in subsetting.py - Add missing Parameters/Returns sections to check_point_in_dataset and check_step - Fix incorrect Returns docstring in check_chunk_size (doesn't return ds) - Fix docstring parameter mismatch in map_dims_and_variables (remove incorrect arch_dim parameter) - Add Returns section to validate_config docstring Co-authored-by: Cursor <cursoragent@cursor.com>
There was a problem hiding this comment.
Pull request overview
This PR fixes various typos and improves docstring formatting across documentation and source files. The changes correct spelling errors in user-facing documentation, fix docstring formatting inconsistencies, add missing docstring sections, and correct inaccurate parameter documentation.
Changes:
- Fix 6 spelling errors in README.md and CHANGELOG.md (e.g., 'handelled' → 'handled', 'gaurantee' → 'guarantee')
- Standardize docstring section underlines to use 7 dashes consistently
- Add missing Parameters/Returns sections to helper functions in selection.py
- Correct inaccurate docstring descriptions (remove non-existent parameters, fix incorrect return values)
Reviewed changes
Copilot reviewed 7 out of 7 changed files in this pull request and generated no comments.
Show a summary per file
| File | Description |
|---|---|
| README.md | Fixed 5 spelling errors in documentation (easiest, handled, distributed, variable, guarantee) |
| CHANGELOG.md | Fixed typo 'ouput' → 'output' and corrected link text '\25' → '#25' |
| mllam_data_prep/ops/subsetting.py | Standardized Returns section underline from 10 dashes to 7 dashes |
| mllam_data_prep/ops/selection.py | Added complete Parameters/Returns sections to check_point_in_dataset and check_step functions |
| mllam_data_prep/ops/mapping.py | Fixed 3 typos in TODO comment and removed incorrect arch_dim parameter from docstring |
| mllam_data_prep/ops/chunking.py | Corrected Returns section to document that function returns None (not ds) |
| mllam_data_prep/config.py | Enhanced validate_config docstring with parameter description and Returns section |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
|
Hi! Could you reformat this PR using our existing PR template: https://github.com/mllam/mllam-data-prep/blob/main/.github/pull_request_template.md ? This guarantees that we follow the development workflows that we have in place. If you have questions about some parts of it feel free to ask! |
|
And this goes for your other PRs as well 😄 Thank you for your help! |
|
sure @joeloskarsson , sorry for breaking the template , i will refine it right now |
Once you have had time to revert to the default PR template feel free to tag me for a review :) |
