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.

Sign up for GitHub

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

Jump to bottom

Documentation evolution #10

Open
mcremone opened this issue Oct 29, 2019 · 1 comment
Open

Documentation evolution #10

mcremone opened this issue Oct 29, 2019 · 1 comment
Labels
development documentation Improvements or additions to documentation

Comments

@mcremone
Copy link
Contributor

No description provided.

@nsmith- nsmith- changed the title Documentation Documentation evolution Dec 6, 2019
@nsmith-
Copy link
Member

nsmith- commented Dec 6, 2019

Following https://www.divio.com/blog/documentation/ I've been trying to migrate the documentation to a structure that delinates between API reference guide, tutorials, how-to guides, and exposition. So far:

  • API is pretty well covered, although function docstrings can always be improved.
  • Tutorials and how-tos are mixed together
  • Exposition of some concepts was started in the 'Concepts' section

https://coffeateam.github.io/coffea/

@mcremone mcremone added the documentation Improvements or additions to documentation label Jan 31, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
development documentation Improvements or additions to documentation
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
2 participants
@nsmith- @mcremone