Repository navigation
Idea: add a 'performance' section to the docs for each sub-package #5753
Description
For each sub-package, there are various tips and tricks to improve performance. It would be nice if in the docs for each sub-package, we had a performance section that discusses any performance considerations for that specific sub-package. For instance, for astropy.coordinates, we would mention things like using SkyCoord arrays instead of SkyCoord. For astropy.units, we could point out how to make a quantity without copying the data, and so on.
Reacted by P. L. Lim, Marten van Kerkwijk, Brigitta Sipőcz, Tom Aldcroft and Larry Bradley
Activity
eteq commentedon Sep 18, 2017
Decision from the 2017 coordination meeting:
performance.rstfile in their documentation sectioneteq commentedon Jun 22, 2018
From discussion in the June 22,2018 Astropy telecon: it should be possible to use
.. include::to have the performance section appear inline for short performance sections. This doesn't block making all theperformance.rstsections, though.pllim commentedon Aug 21, 2018
For units, based on performance survey, should also include discussion on how to get better performance via vectorization and strategically placed parenthesis.
bsipocz commentedon Nov 7, 2018
@astropy/astropy-core-maintainers - please don't forget to fill out the performace section of the narrative documentation for your subpackages, those documents have to be part of the 3.1 release.
bsipocz commentedon Nov 13, 2018
This was addressed in #8096, we don't need this issue being open to add more such tips to the docs.