AxisArrays.jl icon indicating copy to clipboard operation
AxisArrays.jl copied to clipboard

Published 20 hours ago • verified publisher icon JuliaArrays

Simplify README

Open mbauman opened this issue 8 years ago • 4 comments
trafficstars

Now that we have doctests, it is even more important that we reduce the duplication here to ensure that the real documentation is the one canonical source.

mbauman avatar Sep 20 '17 20:09 mbauman

See https://github.com/JuliaArrays/AxisArrays.jl/issues/127

iamed2 avatar Oct 16 '17 19:10 iamed2

Looks great to me, I just wasted a little time being confused by the two locations of documentation for this package.

If there are "real" docs with real doctests, it's best just to point the README to those in a very prominent way, I think.

c42f avatar Dec 11 '18 02:12 c42f

Hmm. Looking at the conflicts, not all changes to the README have been done in the docs.

Even more reason to do this (but now can't merge a straightforward version of this without loosing content)

c42f avatar Dec 11 '18 02:12 c42f

On balance I favor having "one true source," so I say we should go with something like this.

timholy avatar Dec 11 '18 13:12 timholy