Focus figure documentation on data - #6
Merged
Conversation
There was a problem hiding this comment.
Pull request overview
This PR refocuses user-facing documentation to describe underlying Ocean Networks Canada (ONC) data (deployment records, archive coverage, and acoustic content) rather than narrating figure presentation choices.
Changes:
- Rewrites quickstart spectrogram explanation to emphasize acoustic content and relative (non-calibrated) dB values.
- Rewords inventory figure descriptions to emphasize ONC deployment records and archive/deployment-window semantics.
- Simplifies custom spectrogram narrative to focus on the recording’s acoustic content.
Reviewed changes
Copilot reviewed 3 out of 3 changed files in this pull request and generated 2 comments.
| File | Description |
|---|---|
| docs/quickstart.md | Updates spectrogram explanation to focus on data interpretation rather than plot mechanics. |
| docs/inventory.md | Reframes deployment/availability figure descriptions around ONC records, coverage, and deployment windows. |
| docs/custom_spectrograms.md | Tightens spectrogram description to emphasize acoustic content in the ONC recording. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Comment on lines
+105
to
+107
| The availability result distinguishes archived data, gaps during a deployment, | ||
| and dates when the device was not deployed. Coverage is calculated from the | ||
| fraction of expected files present in each daily bin. |
Comment on lines
+127
to
+129
| Each calendar value is the fraction of expected files found for that day. A | ||
| zero value within a deployment is an archive gap; dates outside a deployment | ||
| are recorded separately rather than treated as missing data. |
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.
What changed
Why
The documentation should explain the underlying ONC data rather than narrating visualization design choices that are already apparent from the figures.
Impact
Users get more concise documentation focused on deployment records, archive coverage, acoustic content, dates, and provenance.
Validation
mkdocs build --strict: passedgit diff --cached --check: passed