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

Document Nphase in UVH5 Memo #1233

Merged

Conversation

radonnachie
Copy link
Contributor

Description

Add an entry for the Nphase Header dataset, just above the related phase_center_catalog entry in the UVH5 Memo tex file.

Motivation and Context

Without Nphase v1.1 UVH5 files cannot be interpreted (#1224).

Types of changes

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to change)
  • Documentation change (documentation changes only)
  • Version change
  • Build or continuous integration change

Checklist:

Documentation change checklist:

  • If this is a significant change to the readme or other docs, I have checked that they are rendered properly on ReadTheDocs. (you may need help to get this branch to build on RTD, just ask!)

@bhazelton bhazelton added docs documentation UVH5 labels Dec 8, 2022
@bhazelton
Copy link
Member

Thanks @radonnachie this is really helpful! I think we should also update the pdf. To get it to compile I think you'll need to install minted and pygments packages. If you'd rather, I can also do it as long as I have permissions to push to your fork.

@codecov
Copy link

codecov bot commented Dec 12, 2022

Codecov Report

Merging #1233 (fe0c36a) into main (f5eea81) will not change coverage.
The diff coverage is n/a.

Additional details and impacted files

Impacted file tree graph

@@           Coverage Diff           @@
##             main    #1233   +/-   ##
=======================================
  Coverage   99.93%   99.93%           
=======================================
  Files          33       33           
  Lines       18062    18062           
=======================================
  Hits        18051    18051           
  Misses         11       11           

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update f5eea81...fe0c36a. Read the comment docs.

Copy link
Member

@bhazelton bhazelton left a comment

Choose a reason for hiding this comment

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

This looks great @radonnachie, thank you! The only thing we need to do is to add the compiled pdf so that the pdf in the repo is up to date. I'm happy to do that if you want to give me push access to your fork.

@radonnachie
Copy link
Contributor Author

I'd love to @bhazelton, but I cannot (it seems because the fork is not user-owned, but organization owned).

So we're at a bit of a stalemate... I suppose if you wanted you could fork from mine PR to me I merge, then we merge here.

Or you could just copy paste the documentation to your own branch and get it all done without this PR. I'm not fussed about such a trivial contribution, especially when you're generating the PDF. I did try, but my MikTex is not happy with the task 🤷.

Thanks!

@bhazelton
Copy link
Member

We'll do the simple thing -- I'll merge this and then make another PR with the updated PDF. Thank you for the fix!

@bhazelton bhazelton merged commit 4452551 into RadioAstronomySoftwareGroup:main Dec 15, 2022
bhazelton added a commit that referenced this pull request Dec 15, 2022
bhazelton added a commit that referenced this pull request Dec 19, 2022
bhazelton added a commit that referenced this pull request Dec 19, 2022
bhazelton added a commit that referenced this pull request Dec 20, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs documentation UVH5
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants