search

Deech08 / whampy

Python Package to Interact with, Visualize, and Analyze the Wisconsin H-Alpha Mapper - Sky Survey
BSD 3-Clause "New" or "Revised" License
8 stars 1 forks source link

Clear link to documentation #4

Closed HeloiseS closed 4 years ago

HeloiseS commented 4 years ago

I struggled a little bit to find a link to your documentation in your README.

The WHAM link under the badges is broken and I wonder if that wasn't meant to link to the docs (regardless you should update the broken link).

I found this by clicking the doc:passing badge (I'll go through it later).

I think this deserves a link of it's own and a clear header in your README :)

This issue is part of the current JOSS-review of whampy ( #1940 )

Deech08 commented 4 years ago

I've added a section after the Quick Start that links explicitly to the documentation. I was hoping users would just click on the doc:passing badge, but see that isn't super obvious.

The broken WHAM link is also now fixed - it directs to a webpage on the instrument itself.