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

Add a developing with spectral-cube docs page #798

Merged
merged 8 commits into from
Jan 27, 2022

Conversation

e-koch
Copy link
Contributor

@e-koch e-koch commented Jan 26, 2022

Adding a page that lists out suggestions for incorporating spectral-cube in new packages, or adding custom functions to apply to cubes.

Also adds a bit more detail into how we use dask.Array under the hood.

@e-koch e-koch requested a review from keflavich January 26, 2022 22:35
@codecov-commenter
Copy link

codecov-commenter commented Jan 26, 2022

Codecov Report

❗ No coverage uploaded for pull request base (master@d5ab192). Click here to learn what that means.
The diff coverage is n/a.

Impacted file tree graph

@@            Coverage Diff            @@
##             master     #798   +/-   ##
=========================================
  Coverage          ?   77.94%           
=========================================
  Files             ?       24           
  Lines             ?     5853           
  Branches          ?        0           
=========================================
  Hits              ?     4562           
  Misses            ?     1291           
  Partials          ?        0           

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 d5ab192...055f9e0. Read the comment docs.

Copy link
Contributor

@keflavich keflavich left a comment

Choose a reason for hiding this comment

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

a few copy-edits. Could probably use another reviewer later, but very good


Notes for development using spectral-cube
=========================================
.. currentmodule:: spectral_cube
Copy link
Contributor

Choose a reason for hiding this comment

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

whooaaaa didn't know you could do this.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Me either! I copy-pasted from docs Chris wrote.

docs/developing_with_spectralcube.rst Outdated Show resolved Hide resolved
docs/developing_with_spectralcube.rst Outdated Show resolved Hide resolved
docs/developing_with_spectralcube.rst Outdated Show resolved Hide resolved
@e-koch e-koch merged commit 7d0b9c7 into radio-astro-tools:master Jan 27, 2022
@e-koch e-koch deleted the developer_docs_page branch January 27, 2022 14:14
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.

3 participants