Skip to content

[CLEANUP] Numpy-docstrings and type annotations#73

Merged
eleanorfrajka merged 3 commits into
mainfrom
eleanor-cleanup-2
Sep 21, 2025
Merged

[CLEANUP] Numpy-docstrings and type annotations#73
eleanorfrajka merged 3 commits into
mainfrom
eleanor-cleanup-2

Conversation

@eleanorfrajka

Copy link
Copy Markdown
Collaborator

Description:

Updating docstrings to be numpy-style.

Added type annotations to function signatures.

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull Request Overview

This PR converts function docstrings from Google style to NumPy style and adds comprehensive type annotations to function signatures throughout the seagliderOG1 package.

  • Standardized all docstrings to follow NumPy documentation format with proper section headers
  • Added type annotations to all function signatures with appropriate imports (e.g., xr.Dataset, union types)
  • Enhanced documentation with more detailed parameter descriptions and better structure

Reviewed Changes

Copilot reviewed 5 out of 5 changed files in this pull request and generated 5 comments.

Show a summary per file
File Description
seagliderOG1/writers.py Added xarray import and type annotations to save_dataset function
seagliderOG1/vocabularies.py Added comprehensive module-level docstring and improved inline comments
seagliderOG1/readers.py Added module docstring and converted all functions to NumPy-style docs with type annotations
seagliderOG1/plotters.py Added module docstring and converted plotting functions to NumPy-style docs with type annotations
seagliderOG1/convertOG1.py Added module docstring and converted conversion functions to NumPy-style docs with type annotations

Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.

Comment thread seagliderOG1/readers.py
Comment thread seagliderOG1/readers.py Outdated
Comment thread seagliderOG1/readers.py Outdated
Comment thread seagliderOG1/readers.py
Comment thread seagliderOG1/plotters.py
eleanorfrajka and others added 2 commits September 21, 2025 15:38
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
@eleanorfrajka eleanorfrajka merged commit 0a26304 into main Sep 21, 2025
7 checks passed
@eleanorfrajka eleanorfrajka deleted the eleanor-cleanup-2 branch September 21, 2025 13:42
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