Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Updates to Raw data format pages #1134

Merged
merged 9 commits into from
Aug 27, 2023

Conversation

emiliom
Copy link
Collaborator

@emiliom emiliom commented Aug 26, 2023

  • Generalize the name and title of data-format-5to6 page
  • Add section describing 0.7.1 to 0.8.0 major changes
  • Fix some broken links, including the SONAR-netCDF4 v1 report url
  • Add section that stub that will includes a brief reference to the echopype-checker package and repo. Note that I've already renamed the repository (and package) to echopype-checker and made it public. But I haven't overhauled its README file yet.

@emiliom emiliom added the docs label Aug 26, 2023
@emiliom emiliom added this to the 0.8.0 milestone Aug 26, 2023
@emiliom emiliom requested a review from leewujung August 26, 2023 00:21
@emiliom emiliom self-assigned this Aug 26, 2023
@review-notebook-app
Copy link

Check out this pull request on  ReviewNB

See visual diffs & provide feedback on Jupyter Notebooks.


Powered by ReviewNB

@leewujung
Copy link
Member

@emiliom : I made the following changes via direct push:

  • make mentions of "version 1" and "v1" consistent: all changed to "version 1"
  • remove "and is required for these two variables": I assume you are referring to the requirement in the convention, but in the context of this sentence it is a bit hard to decipher; and I think the key info in this sentence is complete without this subsentence.
  • change everything to present tense to be consistent with release notes (since there are some tricky cases where past tense does not make sense when describing data files in general)
  • make bullet point format more consistent: "In XYZ group: ..."

Copy link
Member

@leewujung leewujung left a comment

Choose a reason for hiding this comment

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

Thanks @emiliom ! I'll now merge this.

@leewujung leewujung merged commit 3407147 into OSOceanAcoustics:dev Aug 27, 2023
5 checks passed
@emiliom emiliom deleted the docs-raw-data-formats branch August 27, 2023 20:47
@emiliom
Copy link
Collaborator Author

emiliom commented Aug 27, 2023

Thanks! Your edits look good.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
Status: Done
Development

Successfully merging this pull request may close these issues.

2 participants