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

update the front page documentation #1267

Merged
merged 3 commits into from
Aug 18, 2015
Merged

update the front page documentation #1267

merged 3 commits into from
Aug 18, 2015

Conversation

ctb
Copy link
Member

@ctb ctb commented Aug 18, 2015

Clarity / friendliness updates. Somewhat responsive to #853.

@ctb
Copy link
Member Author

ctb commented Aug 18, 2015

  • Is it mergeable?
  • Did it pass the tests?
  • If it introduces new functionality in scripts/ is it tested?
    Check for code coverage with make clean diff-cover
  • Is it well formatted? Look at make pep8, make diff_pylint_report,
    make cppcheck, and make doc output. Use make format and manual
    fixing as needed.
  • Did it change the command-line interface? Only additions are allowed
    without a major version increment. Changing file formats also requires a
    major version number increment.
  • Is it documented in the ChangeLog?
    http://en.wikipedia.org/wiki/Changelog#Format
  • Was a spellchecker run on the source code and documentation after
    changes were made?
  • Do the changes respect streaming IO? (Are they
    tested for streaming IO?)
  • Is the Copyright year up to date?

@ctb ctb added this to the 2.0 milestone Aug 18, 2015
@ctb
Copy link
Member Author

ctb commented Aug 18, 2015

ready for review and merge @mr-c

@mr-c
Copy link
Contributor

mr-c commented Aug 18, 2015

LGTM. There was an existing CSS error that I've fixed.

mr-c added a commit that referenced this pull request Aug 18, 2015
update the front page documentation
@mr-c mr-c merged commit c7c7606 into master Aug 18, 2015
@mr-c
Copy link
Contributor

mr-c commented Aug 18, 2015

Thanks!

@mr-c mr-c deleted the update/docover branch August 18, 2015 20:58
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