From c6363686ab18cfc52ec1f7d641a7c87c7c5b6c2f Mon Sep 17 00:00:00 2001 From: Andy Kluger Date: Sun, 15 Sep 2019 20:46:37 -0400 Subject: [PATCH] Feature/proper rst (#464) * Use rst title syntax for Unreleased section of changelog, like the other sections have, rather than a horizontal line * Convert CONTRIBUTING.rst from md -> rst, as the filename suggests it to be --- CHANGELOG.rst | 2 +- CONTRIBUTING.rst | 14 ++++++++------ 2 files changed, 9 insertions(+), 7 deletions(-) diff --git a/CHANGELOG.rst b/CHANGELOG.rst index 64f48fd2a..fbef18d6e 100644 --- a/CHANGELOG.rst +++ b/CHANGELOG.rst @@ -1,5 +1,5 @@ Unreleased ------ +---------- * Exceptions: Changed ProcessExecutionError's formatting to be more user-friendly (`#456 `_) * Commands: support for per-line timeout with iter_lines (`#454 `_) * Commands: support for piping stdout/stderr to a logger (`#454 `_) diff --git a/CONTRIBUTING.rst b/CONTRIBUTING.rst index 583d82793..245256146 100644 --- a/CONTRIBUTING.rst +++ b/CONTRIBUTING.rst @@ -1,14 +1,16 @@ -# Contributing to Plumbum +Contributing to Plumbum +======================= +General comments +---------------- -## General comments +Pull requests welcome! Please make sure you add tests (in an easy ``pytest`` format) to the tests folder for your fix or features. Make sure you add documentation covering a new feature. -Pull requests welcome! Please make sure you add tests (in an easy `pytest` format) to the tests folder for your fix or features. Make sure you add documentation covering a new feature. - -## Adding a language +Adding a language +----------------- Plumbum.cli prints various messages for the user. These can be localized into your local language; pull requests adding languages are welcome. -To add a language, run `./translations.py` from the main github directory, and then copy the file `plumbum/cli/i18n/messages.pot` to `plumbum/cli/i18n/.po`, and add your language. Run `./translations.py` again to update the file you made (save first) and also create the needed files binary file. +To add a language, run ``./translations.py`` from the main github directory, and then copy the file ``plumbum/cli/i18n/messages.pot`` to ``plumbum/cli/i18n/.po``, and add your language. Run ``./translations.py`` again to update the file you made (save first) and also create the needed files binary file. See `gettext: PMOTW3 `_ for more info.