Repository navigation
Added/expanded performance tips - #8096
Conversation
|
Hi there @astrofrog 👋 - thanks for the pull request! I'm just a friendly 🤖 that checks for issues related to the changelog and making sure that this pull request is milestoned and labeled correctly. This is mainly intended for the maintainers, so if you are not a maintainer you can ignore this, and a maintainer will let you know if any action is required on your part 😃. Everything looks good from my point of view! 👍 If there are any issues with this message, please report them here. |
Co-Authored-By: astrofrog <[email protected]>
Codecov Report
@@ Coverage Diff @@
## master #8096 +/- ##
==========================================
- Coverage 86.92% 86.92% -0.01%
==========================================
Files 383 383
Lines 57821 57834 +13
Branches 1056 1056
==========================================
+ Hits 50262 50271 +9
- Misses 6945 6949 +4
Partials 614 614
Continue to review full report at Codecov.
|
mhvk
left a comment
There was a problem hiding this comment.
@astrofrog - thanks very much for taking this on! I checked coordinates (very clear) and units (one small comment).
Add nddata performance tips
|
|
||
| Here we provide some tips and tricks for how to optimize performance of code | ||
| using `astropy.constants`. | ||
| .. Performance Tips |
There was a problem hiding this comment.
shouldn't we just remove this file?
|
I go ahead and merge this, but in a follow-up PR we may want to consider to remove the empty performance files rather than commenting out the generic content? |
|
Thank you @astrofrog and @nden and @mwcraig! |
Added/expanded performance tips
Prior to this PR there weren't actually many performance tips, and I feel like the ones that were there were written as if to an expert audience. I think we should really aim to include tips that may seem like stating the obvious but that we can point general users to - for example, use SkyCoord with arrays, etc.
This PR is an attempt to populate some of the performance tips sections, and also re-writes the units one in a more user-friendly way since that is one of the most common ones. I've also commented out sections that are not populated right now since otherwise users will see a section that says 'this section includes tips' with nothing in them yet.
@adrn @eteq @StuartLittlefair @taldcroft @saimn @MSeifert04 @drdavella @crawfordsm @larrybradley @mhvk - you are all maintainers on sub-packages where I have added/expanded tips, so this is just to let you know in case you want to review/expand with other tips.
If you'd like to add more tips, you can just open a PR to my branch if you like (to avoid conflicts in master)
In the interest of time, I think we should just merge this once we are ready to do the RC.