search

JuliaArrays / AxisArrays.jl

Performant arrays where each dimension can have a named axis with values
http://JuliaArrays.github.io/AxisArrays.jl/latest/
Other
200 stars 41 forks source link

Simplify README #123

Open mbauman opened 6 years ago

mbauman commented 6 years ago

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.

iamed2 commented 6 years ago

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

c42f commented 5 years ago

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 commented 5 years ago

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)

timholy commented 5 years ago

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