Fix long description (#172)

scls19fr · web-flow · commit 1bafb9f0aea0 · 2019-10-30T16:15:53.000+01:00
* Fix long description

* Fix release procedure
diff --git a/README.rst b/README.rst
@@ -42,7 +42,7 @@ To import this library, use:
     >>> import semver
 
 Working with the library is quite straightforward. To turn a version string into the
-different parts, use the :func:`semver.parse` function:
+different parts, use the `semver.parse` function:
 
 .. code-block:: python
 
@@ -59,10 +59,10 @@ different parts, use the :func:`semver.parse` function:
     'build.5'
 
 To raise parts of a version, there are a couple of functions available for
-you. The :func:`semver.parse_version_info` function converts a version string
-into a :class:`semver.VersionInfo` class. The function
-:func:`semver.VersionInfo.bump_major` leaves the original object untouched, but
-returns a new :class:`semver.VersionInfo` instance with the raised major part:
+you. The `semver.parse_version_info` function converts a version string
+into a `semver.VersionInfo` class. The function
+`semver.VersionInfo.bump_major` leaves the original object untouched, but
+returns a new `semver.VersionInfo` instance with the raised major part:
 
 .. code-block:: python
 
@@ -77,7 +77,7 @@ It is allowed to concatenate different "bump functions":
     >>> ver.bump_major().bump_minor()
     VersionInfo(major=4, minor=0, patch=1, prerelease=None, build=None)
 
-To compare two versions, semver provides the :func:`semver.compare` function.
+To compare two versions, semver provides the `semver.compare` function.
 The return value indicates the relationship between the first and second
 version:
 
diff --git a/release-procedure.md b/release-procedure.md
@@ -19,14 +19,7 @@ Release procedure
 
 * Add eventually new contributor(s) to [CONTRIBUTORS](https://github.com/k-bx/python-semver/blob/master/CONTRIBUTORS)
 
-* Tag commit and push to github using command line interface
-
-```bash
-git tag -a x.x.x -m 'Version x.x.x'
-git push python-semver master --tags
-```
-
-or using GitHub web interface available at https://github.com/k-bx/python-semver/releases
+* Ensure that long description (ie [README.rst](https://github.com/k-bx/python-semver/blob/master/README.rst)) can be correctly rendered by Pypi using `restview --long-description`
 
 * Upload to PyPI
 
@@ -37,3 +30,12 @@ twine upload dist/*
 ```
 
 * Go to https://pypi.org/project/semver/ to verify that new version is online and page is rendered correctly
+
+* Tag commit and push to github using command line interface
+
+```bash
+git tag -a x.x.x -m 'Version x.x.x'
+git push python-semver master --tags
+```
+
+or using GitHub web interface available at https://github.com/k-bx/python-semver/releases
