search

radio-astro-tools / radio-beam

A simple toolkit for reading and manipulating beams from astrophysical radio spectral data cubes.
https://radio-beam.readthedocs.io/en/latest/
BSD 3-Clause "New" or "Revised" License
26 stars 21 forks source link

Add more documentation about common beam convolution #113

Closed keflavich closed 2 years ago

keflavich commented 2 years ago

Relatively minor docs addition.

@e-koch might need your help reminding me where I need doctest-skip directives etc.

Also I hope this is all syntactically correct.... did it from memory w/o testing 😬

keflavich commented 2 years ago

is there no directive to skip a whole block? I didn't find one by googling, but my google hit rate for sphinx is uniformly low.

e-koch commented 2 years ago

Not sure either.

keflavich commented 2 years ago

apparently I'm bad at intersphinx too; I want to reference the spectral-cube docs on smoothing but that failed: https://github.com/radio-astro-tools/radio-beam/actions/runs/3337835531/jobs/5524692842#step:5:121 /home/runner/work/radio-beam/radio-beam/docs/commonbeam.rst:58:unknown document: 'spectral-cube:smoothing'

codecov-commenter commented 2 years ago

Codecov Report

Base: 86.00% // Head: 86.15% // Increases project coverage by +0.14% :tada:

Coverage data is based on head (ec08875) compared to base (3332cba). Patch has no changes to coverable lines.

:exclamation: Current head ec08875 differs from pull request most recent head 502e072. Consider uploading reports for the commit 502e072 to get more accurate results

Additional details and impacted files ```diff @@ Coverage Diff @@ ## master #113 +/- ## ========================================== + Coverage 86.00% 86.15% +0.14% ========================================== Files 12 12 Lines 1365 1365 ========================================== + Hits 1174 1176 +2 + Misses 191 189 -2 ``` | [Impacted Files](https://codecov.io/gh/radio-astro-tools/radio-beam/pull/113?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=radio-astro-tools) | Coverage Δ | | |---|---|---| | [radio\_beam/beam.py](https://codecov.io/gh/radio-astro-tools/radio-beam/pull/113/diff?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=radio-astro-tools#diff-cmFkaW9fYmVhbS9iZWFtLnB5) | `85.65% <0.00%> (+0.77%)` | :arrow_up: | Help us with your feedback. Take ten seconds to tell us [how you rate us](https://about.codecov.io/nps?utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=radio-astro-tools). Have a feature suggestion? [Share it here.](https://app.codecov.io/gh/feedback/?utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=radio-astro-tools)

:umbrella: View full report at Codecov.
:loudspeaker: Do you have feedback about the report comment? Let us know in this issue.