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

Document w/ documentary #478

Open
wants to merge 4 commits into
base: master
Choose a base branch
from
Open

Conversation

zavr-1
Copy link

@zavr-1 zavr-1 commented Sep 5, 2018

The advantages are:

  1. Table of contents for faster navigation and better structure perception.
  2. Embedding examples and executing them to print the output. Removes inconsistencies between the documentation and what is the actual output. Saves time between copying and pasting.
  3. Structure by files for easier maintenance.
  4. More quality control as the examples will be forked when compiled, meaning output will change if the output is incorrect.

@coveralls
Copy link

Coverage Status

Coverage remained the same at 97.633% when pulling 7867faa on docume:master into 0f0a298 on Leonidas-from-XIV:master.

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.

2 participants