From ff3dc793fdcf6b0843443b15bf327d7bbae8a1e0 Mon Sep 17 00:00:00 2001 From: Jeff Quast Date: Sat, 9 May 2015 14:53:48 -0700 Subject: spellfix: derivitive -> derivative --- blessings/formatters.py | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/blessings/formatters.py b/blessings/formatters.py index 8a0f4e4..de99529 100644 --- a/blessings/formatters.py +++ b/blessings/formatters.py @@ -14,8 +14,8 @@ def _make_colors(): """ derivatives = ('on', 'bright', 'on_bright',) colors = set('black red green yellow blue magenta cyan white'.split()) - return set(['_'.join((_derivitive, _color)) - for _derivitive in derivatives + return set(['_'.join((_deravitive, _color)) + for _deravitive in derivatives for _color in colors]) | colors -- cgit v1.2.1 From ca33be09d78b755070e7e2d1a449f267e0fa74aa Mon Sep 17 00:00:00 2001 From: Jeff Quast Date: Sat, 9 May 2015 15:02:02 -0700 Subject: reverse symlink CONTRIBUTING, docs/contributing.py When creating a PR, a hyperlink "Please review the guidelines for contributing to this repository" is displayed, but previously pointed to a symlink record and does not follow it. Reverse direction of symlink, as sphinx-build happily follows and will not affect the documentation. --- CONTRIBUTING | 1 - CONTRIBUTING.rst | 42 ++++++++++++++++++++++++++++++++++++++++++ docs/contributing.rst | 43 +------------------------------------------ 3 files changed, 43 insertions(+), 43 deletions(-) delete mode 120000 CONTRIBUTING create mode 100644 CONTRIBUTING.rst mode change 100644 => 120000 docs/contributing.rst diff --git a/CONTRIBUTING b/CONTRIBUTING deleted file mode 120000 index 7c5f320..0000000 --- a/CONTRIBUTING +++ /dev/null @@ -1 +0,0 @@ -docs/contributing.rst \ No newline at end of file diff --git a/CONTRIBUTING.rst b/CONTRIBUTING.rst new file mode 100644 index 0000000..7018671 --- /dev/null +++ b/CONTRIBUTING.rst @@ -0,0 +1,42 @@ +Contributing +============ + +We welcome contributions via GitHub pull requests: + +- `Fork a Repo `_ +- `Creating a pull request + `_ + +Developing +---------- + +Install git, Python 2 and 3, pip, and tox. + +Then, from the blessings code folder:: + + pip install --editable . + +Running Tests +~~~~~~~~~~~~~ + +Install and run tox + +:: + + pip install --upgrade tox + tox + +Test Coverage +~~~~~~~~~~~~~ + +Blessings has 99% code coverage, and we'd like to keep it that way, as +terminals are fiddly beasts. Thus, when you contribute a new feature, make sure +it is covered by tests. Likewise, a bug fix should include a test demonstrating +the bug. + +Style and Static Analysis +~~~~~~~~~~~~~~~~~~~~~~~~~ + +The test runner (``tox``) ensures all code and documentation complies +with standard python style guides, pep8 and pep257, as well as various +static analysis tools. diff --git a/docs/contributing.rst b/docs/contributing.rst deleted file mode 100644 index 7018671..0000000 --- a/docs/contributing.rst +++ /dev/null @@ -1,42 +0,0 @@ -Contributing -============ - -We welcome contributions via GitHub pull requests: - -- `Fork a Repo `_ -- `Creating a pull request - `_ - -Developing ----------- - -Install git, Python 2 and 3, pip, and tox. - -Then, from the blessings code folder:: - - pip install --editable . - -Running Tests -~~~~~~~~~~~~~ - -Install and run tox - -:: - - pip install --upgrade tox - tox - -Test Coverage -~~~~~~~~~~~~~ - -Blessings has 99% code coverage, and we'd like to keep it that way, as -terminals are fiddly beasts. Thus, when you contribute a new feature, make sure -it is covered by tests. Likewise, a bug fix should include a test demonstrating -the bug. - -Style and Static Analysis -~~~~~~~~~~~~~~~~~~~~~~~~~ - -The test runner (``tox``) ensures all code and documentation complies -with standard python style guides, pep8 and pep257, as well as various -static analysis tools. diff --git a/docs/contributing.rst b/docs/contributing.rst new file mode 120000 index 0000000..798f2aa --- /dev/null +++ b/docs/contributing.rst @@ -0,0 +1 @@ +../CONTRIBUTING.rst \ No newline at end of file -- cgit v1.2.1