tenacity
tenacity copied to clipboard
Documentation page on PyPI has broken formatting
Documentation page on PyPI has broken formatting.
The beginning looks like this:
Retry code until it succeeeds
Tenacity
========
.. image:: https://img.shields.io/pypi/v/tenacity.svg
:target: https://pypi.python.org/pypi/tenacity
.. image:: https://img.shields.io/travis/jd/tenacity.svg
:target: https://travis-ci.org/jd/tenacity
.. image:: https://img.shields.io/badge/SayThanks.io-%E2%98%BC-1EAEDB.svg
:target: https://saythanks.io/to/jd
Tenacity is an Apache 2.0 licensed general-purpose retrying library, written in
Python, to simplify the task of adding retry behavior to just about anything.
It originates from `a fork of retrying
<https: github.com="" rholder="" retrying="" issues="" 65="">`_.
The simplest use case is retrying a flaky function whenever an `Exception`
occurs until a value is returned.
.. testcode::
import random
from tenacity import retry
@retry
def do_something_unreliable():
if random.randint(0, 10) > 1:
raise IOError("Broken sauce, everything is hosed!!!111one")
else:
return "Awesome sauce!"
print(do_something_unreliable())
.. testoutput::
:hide:
Awesome sauce!
Features
--------
testcode::
and testoutput::
are invalid keys for ReST.
Doc is meant to be read once rendered properly by Sphinx on http://tenacity.readthedocs.io/
I guess we cut down the README rendered on PyPI to just a link.
RTD has less strict rules, than PyPI
Also broken on https://github.com/jd/tenacity#tenacity
The description page for PyPI is now completely empty, this is a bit sad :disappointed:
FYI the GitHub readme page also has some issues
@jd his has been fixed https://pypi.org/project/tenacity/