Repository navigation
Re-order documentation for astropy.units - #1591
Conversation
|
@astrofrog - we're of t̶w̶o̶ one mind (see #1577 (comment))! Though my initial solution would have been to move the |
|
@mhvk - your last suggestion sounds good - at the end of the day I agree the |
|
See the overlap with #1595 - if we do that, this is not necessary because it would have it's own doc section. I do not think we should give it it's own section in the doc (as @mhvk originally suggested) unless it has its own subpackage. But I'm also fine with @mhvk's suggestion here to actually put the quantity stuff before the units stuff in the docs (and more prominent in the examples). So now that I see this, I'm actually slightly more in favor of this over #1595. |
|
I'm also not too keen on actually separating |
|
Self assigning. I'll do this work early next week. |
|
Reorganization of units document to emphasize Quantity is attached. It primarily:
This requires #1610 to be merged as well, as it documents a feature there. |
There was a problem hiding this comment.
I'd think this would typically be used more when there are different units. Maybe replace by the following?
``
qlst = [60. * u.s, 1. * u.hr]
|
I went through all the files and it looks good. Apart from the simple comment above, maybe for the |
|
I have addressed @mhvk's comments and (hopefully) fixed the Travis errors. |
|
👍 |
…e-quantity Re-order documentation for astropy.units
I've come across several users who have read the start of the docs for astropy.units and use the original API which involved finding the conversion factor with pure units, then multiplying numbers, rather than using Quantities. I think that we should consider re-ordering the 'getting started' section to start straight with quantities, and then show the pure unit stuff later since it's not as useful now we have Quantity.
@mdboom - what do you think?