-
Notifications
You must be signed in to change notification settings - Fork 12
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
docs update #20
docs update #20
Conversation
Codecov Report
@@ Coverage Diff @@
## master #20 +/- ##
==========================================
+ Coverage 86.91% 87.25% +0.33%
==========================================
Files 7 9 +2
Lines 688 706 +18
==========================================
+ Hits 598 616 +18
Misses 90 90
Continue to review full report at Codecov.
|
as that will duplicate parameters when using "x, y : str" styled parameter documentation
There are still a few things left to do (most notably we need examples / tutorials, and the contributing section could be better), but for now I think I'm done; let's leave those to future PRs. I named the changelog |
I also added install instructions for installing from PyPI and conda-forge, but those obviously don't work, yet. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Looks like a great start to me! Just one point to discuss on using degrees
in place of degrees_north
/degrees_east
in an example.
is there anything other than the name of the changelog left to discuss? |
I figured that since we're closely tied to Merging now, but if we find anything that still needs fixing we can do that in a new PR. |
Right now, our docs cover less than the bare minimum. However, in order to fix that there is quite a lot to do so I'd appreciate some help.
I'm hoping to stay pretty close to the guide lines from https://documentation.divio.com/, with
Help & Reference
listUser Guide
listExamples
Backgrounds
orOther notes
, and that they should explain background and context, and discuss alternatives and opinions. I guess we currently don't have much of these?