launchpad-reviewers team mailing list archive

[Kit Randel <kit.randel@xxxxxxxxxxxxx>]

Kit Randel has proposed merging ~blr/turnip/+git/turnip:fix-rst-warnings into turnip:master.

Commit message:
Ensure README is valid RST (validated with readme_renderer).

Requested reviews:
  Launchpad code reviewers (launchpad-reviewers)

For more details, see:
https://code.launchpad.net/~blr/turnip/+git/turnip/+merge/294747

Pypi is not currently rendering the turnip readme correctly (https://pypi.python.org/pypi/turnip/0.1.1), as it contains invalid RST.

12:07 < lifeless> wgrant: https://pypi.python.org/pypi/turnip/0.1.1 <- note the rendering
-- 
Your team Launchpad code reviewers is requested to review the proposed merge of ~blr/turnip/+git/turnip:fix-rst-warnings into turnip:master.

diff --git a/Makefile b/Makefile
index b088b7a..80bf28c 100644
--- a/Makefile
+++ b/Makefile
@@ -63,6 +63,7 @@ tags:
 
 lint: $(ENV)
 	@$(FLAKE8) --exclude=__pycache__,version_info.py turnip
+	$(PYTHON) setup.py check --restructuredtext --strict
 
 run-api: $(ENV)
 	$(PSERVE) api.ini --reload
diff --git a/README b/README
index 2a13241..edc0da1 100644
--- a/README
+++ b/README
@@ -1,4 +1,3 @@
-======
 turnip
 ======
 
@@ -52,17 +51,17 @@ between its servers. The only change is that turnip requests can specify
 arbitrary named parameters, not just a hostname.
 
 The relevant part of the Git pack protocol's git-proto-request is
-represented in ABNF as follows:
+represented in ABNF as follows::
 
    git-proto-request = request-command SP pathname NUL [ host-parameter NUL ]
    host-parameter = "host=" hostname [ ":" port ]
 
-turnip-proto-request alters it to this:
+turnip-proto-request alters it to this::
 
-   turnip-proto-request = request-command SP pathname NUL *( param NUL )
+   turnip-proto-request = request-command SP pathname NUL \*( param NUL )
    param = param-name "=" param-value
-   param-name = *( %x01-3C / %x3E-FF ) ; exclude NUL and =
-   param-value = *%x01-FF ; exclude NUL
+   param-name = \*( %x01-3C / %x3E-FF ) ; exclude NUL and =
+   param-value = \*%x01-FF ; exclude NUL
 
 The only additional parameters implemented today are
 'turnip-stateless-rpc' and 'turnip-advertise-refs', which are used by