Skip to content
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

Merged
merged 29 commits into from Aug 26, 2020
Merged

docs update #20

merged 29 commits into from Aug 26, 2020

Conversation

keewis
Copy link
Collaborator

@keewis keewis commented Aug 5, 2020

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

  • reference: everything in the Help & Reference list
  • how-to guides: everything in the User Guide list
  • tutorials: everything in Examples
  • explanation: not sure where this should go, the guide says they are usually put into sections named something like Backgrounds or Other notes, and that they should explain background and context, and discuss alternatives and opinions. I guess we currently don't have much of these?

@codecov
Copy link

codecov bot commented Aug 5, 2020

Codecov Report

Merging #20 into master will increase coverage by 0.33%.
The diff coverage is n/a.

Impacted file tree graph

@@            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              
Impacted Files Coverage Δ
pint_xarray/accessors.py 74.82% <ø> (ø)
pint_xarray/__init__.py 100.00% <0.00%> (ø)
pint_xarray/testing.py 100.00% <0.00%> (ø)
pint_xarray/tests/test_testing.py 100.00% <0.00%> (ø)

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 226f747...78c9e62. Read the comment docs.

@keewis
Copy link
Collaborator Author

keewis commented Aug 18, 2020

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 Changelog, but we could just as well copy xarray and call it What's new. Does anyone have any preferences?

@keewis keewis mentioned this pull request Aug 22, 2020
16 tasks
@keewis
Copy link
Collaborator Author

keewis commented Aug 22, 2020

I also added install instructions for installing from PyPI and conda-forge, but those obviously don't work, yet.

Copy link
Collaborator

@jthielen jthielen left a 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.

docs/creation.rst Outdated Show resolved Hide resolved
@keewis keewis mentioned this pull request Aug 23, 2020
7 tasks
@dcherian dcherian mentioned this pull request Aug 24, 2020
@keewis
Copy link
Collaborator Author

keewis commented Aug 25, 2020

is there anything other than the name of the changelog left to discuss?

@keewis
Copy link
Collaborator Author

keewis commented Aug 26, 2020

I figured that since we're closely tied to xarray, we might as well copy the changelog name.

Merging now, but if we find anything that still needs fixing we can do that in a new PR.

@keewis keewis merged commit a335615 into xarray-contrib:master Aug 26, 2020
@keewis keewis deleted the extend-docs branch August 26, 2020 09:17
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants