pyuvdata
pyuvdata copied to clipboard
* docs/ref/uvh5_memo specify baseline direction
Description
Following a discussion on slack, this updates the UVH5 memo to reflect the baseline convention within the uvw_array definition, closely mirroring wording in the uvdata_tutorial. I've taken the liberty to extend the conjugation convention content to echo the definition... this may be contentious, happy to adjust.
Motivation and Context
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)
- [x] Documentation change (documentation changes only)
- [ ] Version change
- [ ] Build or continuous integration change
Checklist:
- [ ] I have read the contribution guide.
- [ ] My code follows the code style of this project.
Bug fix checklist:
- [ ] My fix includes a new test that breaks as a result of the bug (if possible).
- [ ] All new and existing tests pass.
- [ ] I have updated the CHANGELOG.
New feature checklist:
- [ ] I have added or updated the docstrings associated with my feature using the numpy docstring format.
- [ ] I have updated the tutorial to highlight my new feature (if appropriate).
- [ ] I have added tests to cover my new feature.
- [ ] All new and existing tests pass.
- [ ] I have updated the CHANGELOG.
Breaking change checklist:
- [ ] I have updated the docstrings associated with my change using the numpy docstring format.
- [ ] I have updated the tutorial to reflect my changes (if appropriate).
- [ ] My change includes backwards compatibility and deprecation warnings (if possible).
- [ ] I have added tests to cover my changes.
- [ ] All new and existing tests pass.
- [ ] I have updated the CHANGELOG.
Documentation change checklist:
- [ ] Any updated docstrings use the numpy docstring format.
- [ ] 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!)
Version change checklist:
- [ ] I have updated the CHANGELOG to put all the unreleased changes under the new version (leaving the unreleased section empty).
- [ ] I have noted any dependency changes since the last version and will update the conda package build accordingly.
Build or continuous integration change checklist:
- [ ] If required or optional dependencies have changed (including version numbers), I have updated the readme to reflect this.
- [ ] If this is a new CI setup, I have added the associated badge to the readme and to references/make_index.py (if appropriate).
maybe while we're at it, the conjugation convention reference to data_array could be updated to visdata... maybe I'm missing something though...
Codecov Report
All modified and coverable lines are covered by tests :white_check_mark:
Project coverage is 99.92%. Comparing base (
7d3804f) to head (ec2ee03). Report is 4 commits behind head on main.
Additional details and impacted files
@@ Coverage Diff @@
## main #1427 +/- ##
========================================
Coverage 99.92% 99.92%
========================================
Files 37 37
Lines 20868 21029 +161
========================================
+ Hits 20852 21013 +161
Misses 16 16
:umbrella: View full report in Codecov by Sentry.
:loudspeaker: Have feedback on the report? Share it here.