Update docs with information on instrument sensors#341
Merged
Conversation
…ument column entries are consistent
erikvansebille
approved these changes
May 21, 2026
Member
erikvansebille
left a comment
erikvansebille
left a comment
There was a problem hiding this comment.
Looks good; two small comments below
Comment on lines
+13
to
+15
| | **ADCP** | VELOCITY | Current velocities (eastward (u) and northward (v)) | m/s | Physical | | ||
| | **UNDERWATER_ST** (Ship Underwater ST) | TEMPERATURE | Temperature | °C | Physics | | ||
| | | SALINITY | Salinity | psu | Physics | |
Member
There was a problem hiding this comment.
Is there a difference between "Physical" and "Physics"?
Collaborator
Author
There was a problem hiding this comment.
Oops no, I meant to keep it consistent, will change
Member
There was a problem hiding this comment.
Use the same text as the field description as in the Copernicus marine data for each sensor?
j-atkins
force-pushed
the
update-docs-sensors
branch
from
f474279 to
0fe1340
Compare
for more information, see https://pre-commit.ci
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
2 participants
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.
This PR adds content across the docs, providing instruction on how to configure sensor choices for each instrument.
Also adds another docs page which has the master table of all sensors available for each instrument, which is referenced in the tutorials/assignments.
Finally, adds a test which ensures that the documentation is consistent with the code, i.e. that any instrument/sensor combination in the code is in the docs too.
Closes #334