From 4aaf36df5e9f51e7b523573526c57258f23db900 Mon Sep 17 00:00:00 2001 From: Markus Gerstel Date: Mon, 9 Nov 2020 11:39:18 +0000 Subject: [PATCH 1/2] Add a bit of basic documentation courtesy of @frol. Closes #13 --- README.rst | 6 +++++- docs/includes/introduction.txt | 6 +++++- vine/__init__.py | 4 ++-- 3 files changed, 12 insertions(+), 4 deletions(-) diff --git a/README.rst b/README.rst index 6465b2b..dfa3df5 100644 --- a/README.rst +++ b/README.rst @@ -7,12 +7,16 @@ :Version: 5.0.0 :Web: https://vine.readthedocs.io/ :Download: https://pypi.org/project/vine/ -:Source: http://github.com/celery/vine/ +:Source: https://github.com/celery/vine/ :Keywords: promise, async, future About ===== +This is a special implementation of promises in that it can be used both +for promise of a value and lazy evaluation. The biggest upside for this +is that everything in a promise can also be a promise, e.g. filters, +callbacks and errbacks can all be promises. .. |build-status| image:: https://secure.travis-ci.org/celery/vine.png?branch=master :alt: Build status diff --git a/docs/includes/introduction.txt b/docs/includes/introduction.txt index dac6374..2b745a0 100644 --- a/docs/includes/introduction.txt +++ b/docs/includes/introduction.txt @@ -1,9 +1,13 @@ :Version: 5.0.0 :Web: https://vine.readthedocs.io/ :Download: https://pypi.org/project/vine/ -:Source: http://github.com/celery/vine/ +:Source: https://github.com/celery/vine/ :Keywords: promise, async, future About ===== +This is a special implementation of promises in that it can be used both +for promise of a value and lazy evaluation. The biggest upside for this +is that everything in a promise can also be a promise, e.g. filters, +callbacks and errbacks can all be promises. diff --git a/vine/__init__.py b/vine/__init__.py index 03fe6bf..605a17c 100644 --- a/vine/__init__.py +++ b/vine/__init__.py @@ -1,4 +1,4 @@ -"""Promises, promises, promises.""" +"""Python promises""" import re from collections import namedtuple @@ -15,7 +15,7 @@ __version__ = '5.0.0' __author__ = 'Ask Solem' __contact__ = 'ask@celeryproject.org' -__homepage__ = 'http://github.com/celery/vine' +__homepage__ = 'https://github.com/celery/vine' __docformat__ = 'restructuredtext' # -eof meta- From 590524da692bcf92b9dcb91b61eea190175e5804 Mon Sep 17 00:00:00 2001 From: Markus Gerstel Date: Wed, 11 Nov 2020 12:11:44 +0000 Subject: [PATCH 2/2] conform with style requirements --- vine/__init__.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/vine/__init__.py b/vine/__init__.py index 605a17c..962cbf9 100644 --- a/vine/__init__.py +++ b/vine/__init__.py @@ -1,4 +1,4 @@ -"""Python promises""" +"""Python promises.""" import re from collections import namedtuple