Merge README content into the main index doc page #97
Conversation
This adds some informative content to the documentation and centralizes our prose in one place.
|
This seems fine to me. I'm sorry to piggy back on this issue, but I didn't want to open another one, what about the PyData domain? |
|
On second thought, could we add developer information to the GitHub Just two links would be enough, with some very short dev intro, IMO:
Also, can we add a section on filing issues in contributing? Edit: And also rename contribute to contributing... GitHub picks it up and links it when opening a PR or issue that way. |
|
This seems like a good idea to me. I may not get to it until later today
if you'd like to take a shot at it before then.
…On Tue, Jan 30, 2018 at 4:34 AM, Hameer Abbasi ***@***.***> wrote:
On second thought, could we add developer information to the GitHub README?
Kind of like SciPy <https://github.com/scipy/scipy/blob/master/README.rst>
.
Just two links would be enough, with some very short dev intro, IMO:
- Contributing
- Docs
Also, can we add a section on filing issues in contributing?
—
You are receiving this because you authored the thread.
Reply to this email directly, view it on GitHub
<#97 (comment)>, or mute
the thread
<https://github.com/notifications/unsubscribe-auth/AASszEJfjHbOmZITCrV9TEWOUuXPlcnSks5tPuJCgaJpZM4RxL24>
.
|
* Fix all broken links in the docs. * Add useful links to README.
|
@mrocklin, I could use your input here. :-) |
| @@ -9,7 +9,7 @@ Operators | |||
| --------- | |||
|
|
|||
| :obj:`COO` objects support a number of operations. They interact with scalars, | |||
| :obj:`numpy.ndarray` objects, other :obj:`COO` objects, and | |||
| :doc:`Numpy arrays <reference/generated/numpy.ndarray>`, other :obj:`COO` objects, and | |||
There was a problem hiding this comment.
I'm curious, why was this change required?
There was a problem hiding this comment.
Saying "numpy dot enn dee array objects" is a mouthful. I thought it would be easier for readers to just change it to "Numpy arrays."
|
In general this seems fine to me. I'm in favor of merging. |
* Merge README content into the main index doc page This adds some informative content to the documentation and centralizes our prose in one place. * Range of changes to docs. * Fix all broken links in the docs. * Add useful links to README.
This adds some informative content to the documentation
and centralizes our prose in one place.