[REFACTOR] Rename the report package to reports - #73
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Renames the
oceanarray.reportsubpackage tooceanarray.reports, normalising it to the plural convention shared by the other subpackages (readers/,writers/,plotters/,processors/) and matching the sisterctdcastproject. This is a structural move only — no rendered output changes, which the golden-file test (added in the previous change) confirms byte-for-byte.What changed
git mv oceanarray/report → oceanarray/reports(all 12 module files moved with history preserved).oceanarray.report,from .report …,from ..report …— acrossoceanarray/,tests/, anddocs/(16 files). The renames used anchored patterns so the CLI verboceanarray report, the report output directory ({proc}/{mooring}/report/, unchanged by this move), and prose uses of the word "report" were left untouched.oceanarray/report/*.pyper-file ruff exemptions inpyproject.tomltooceanarray/reports/*.py.docs/source/project_structure.md(the tier table and directory tree) fromreport/…toreports/…; the CLI verb and output-path references there were left as-is.Verification
ruff checkclean. Docs build produces no new warnings (the pre-existing docstring-formatting warnings are unrelated to this change).import oceanarray.reports, the CLI, and every submodule import resolve.Breaking changes
The public import path changes:
oceanarray.report→oceanarray.reports.Migration for any external caller, notebook, or script:
The
oceanarray reportCLI command is unchanged, and the report output directory ({proc}/{mooring}/report/) is unchanged — only the Python import path moved.