Skip to content

[CLEANUP] Move config/ into seagliderOG1/#74

Merged
eleanorfrajka merged 10 commits into
mainfrom
eleanor-docs-2
Sep 21, 2025
Merged

[CLEANUP] Move config/ into seagliderOG1/#74
eleanorfrajka merged 10 commits into
mainfrom
eleanor-docs-2

Conversation

@eleanorfrajka

@eleanorfrajka eleanorfrajka commented Sep 21, 2025

Copy link
Copy Markdown
Collaborator

Description:

The config/ directory with the *.yaml files wasn't shipping with the package.

Here, we move it into the seagliderOG1/ directory and update the pyproject.toml.

Checklist:

  • I have followed the coding conventions.
  • I have updated or added tests to cover my changes.
  • I have updated the documentation if needed.
  • I have run pytest to check that all tests pass.
  • I have run pre-commit run --all-files to lint and format the code.

Related Issues / Pull Requests:

Link any related issues, pull requests, or discussions:

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 moves configuration files from the config/ directory into the seagliderOG1/ package directory to ensure they are properly packaged and distributed with the library.

  • Relocates YAML configuration files to seagliderOG1/config/
  • Updates path resolution in vocabularies.py to find configs in the new location
  • Updates pyproject.toml to include the config files in the package distribution

Reviewed Changes

Copilot reviewed 18 out of 26 changed files in this pull request and generated 8 comments.

Show a summary per file
File Description
seagliderOG1/vocabularies.py Updates config directory path from parent to package directory
pyproject.toml Adds package-data configuration to include YAML files
Multiple .py files Standardizes docstring formatting from multi-line to single-line style
Multiple .ipynb files Removes unused imports
Documentation files Updates references to new config directory location

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

Comment thread seagliderOG1/utilities.py
Comment thread seagliderOG1/tools.py Outdated
Comment thread seagliderOG1/tools.py Outdated
Comment thread seagliderOG1/readers.py Outdated
Comment thread seagliderOG1/plotters.py Outdated
Comment thread seagliderOG1/old-tools.py Outdated
Comment thread seagliderOG1/old-tools.py Outdated
Comment thread seagliderOG1/convertOG1.py Outdated
eleanorfrajka and others added 7 commits September 21, 2025 16:09
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
@eleanorfrajka eleanorfrajka merged commit 6876828 into main Sep 21, 2025
7 checks passed
@eleanorfrajka eleanorfrajka deleted the eleanor-docs-2 branch September 21, 2025 14:13
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