Skip to content

Commit

Permalink
yaml formatting in 02
Browse files Browse the repository at this point in the history
  • Loading branch information
tracykteal committed Dec 31, 2017
1 parent c0e46e6 commit 8dde7e5
Showing 1 changed file with 5 additions and 5 deletions.
10 changes: 5 additions & 5 deletions _episodes/02-documentation.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,15 +3,15 @@ title: Documentation
teaching: 10
exercises: 20
questions:
- "Why should I invest time in good documentation?"
- How does my target audience influence my documentation strategy?
- "What are some published examples of good documentation?
- Why should I invest time in good documentation?
- How does my target audience influence my documentation strategy?
- What are some published examples of good documentation?
objectives:
- Describe how documentation is useful to yourself and to others
- Evaluate and rank the quality of comments in published notebooks
keypoints:
- "Your code tells *what* you did. Your documentation tells *why* you did it and why it is important."
- "Documentation is the key to communicating your workflow and findings with your future self, collaborators, peers, and the general public."
- Your code tells *what* you did. Your documentation tells *why* you did it and why it is important.
- Documentation is the key to communicating your workflow and findings with your future self, collaborators, peers, and the general public.
---

## Overview
Expand Down

0 comments on commit 8dde7e5

Please sign in to comment.