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

Update docs to reflect changes in TICA cube format #93

Merged
merged 12 commits into from
Aug 25, 2023
Merged

Conversation

hmlewis-astro
Copy link
Contributor

@hmlewis-astro hmlewis-astro commented Aug 22, 2023

Update docs to reflect changes in TICA cube format

@codecov
Copy link

codecov bot commented Aug 22, 2023

Codecov Report

Patch and project coverage have no change.

Comparison is base (fe56d85) 94.45% compared to head (f613144) 94.45%.
Report is 1 commits behind head on main.

❗ Current head f613144 differs from pull request most recent head 013f80f. Consider uploading reports for the commit 013f80f to get more accurate results

Additional details and impacted files
@@           Coverage Diff           @@
##             main      #93   +/-   ##
=======================================
  Coverage   94.45%   94.45%           
=======================================
  Files           8        8           
  Lines        1443     1443           
=======================================
  Hits         1363     1363           
  Misses         80       80           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

Copy link
Collaborator

@jaymedina jaymedina left a comment

Choose a reason for hiding this comment

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

Requesting a typo fix. Also, those numbers (15 mins and 45 mins) are outdated, and I think we should update them in case a user is trying to make their own cubes and find that their processing time is wildly different from what's documented: Could you update the processing time for a 64 GB machine for EM2 data? And then for that last sentence you can just put On a system with less memory [...], this time can increase significantly.

It says there are 2 files changed in this PR but I only see the index.rst changes, so I might have to do another review for the other file.

docs/astrocut/index.rst Outdated Show resolved Hide resolved
Copy link
Collaborator

@jaymedina jaymedina left a comment

Choose a reason for hiding this comment

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

Thank you for doing this! Just some small typos and incomplete sentences, but no large structural changes required, this looks good.

docs/astrocut/file_formats.rst Outdated Show resolved Hide resolved
docs/astrocut/file_formats.rst Outdated Show resolved Hide resolved
docs/astrocut/file_formats.rst Outdated Show resolved Hide resolved
docs/astrocut/file_formats.rst Outdated Show resolved Hide resolved
docs/astrocut/file_formats.rst Outdated Show resolved Hide resolved
docs/astrocut/file_formats.rst Outdated Show resolved Hide resolved
docs/astrocut/file_formats.rst Show resolved Hide resolved
docs/astrocut/index.rst Outdated Show resolved Hide resolved
docs/astrocut/index.rst Outdated Show resolved Hide resolved
docs/astrocut/index.rst Outdated Show resolved Hide resolved
docs/astrocut/index.rst Outdated Show resolved Hide resolved
@jaymedina jaymedina self-requested a review August 25, 2023 20:20
@jaymedina jaymedina merged commit ac8fad9 into main Aug 25, 2023
5 of 6 checks passed
@jaymedina jaymedina deleted the tica-update-docs branch August 25, 2023 20:22
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.

4 participants