diff mbox

[v2] gnu: sqlalchemy-utils: Update description to include optional dependencies.

Message ID 20161106211253.6100-1-dannym@scratchpost.org
State New
Headers show

Commit Message

Danny Milosavljevic Nov. 6, 2016, 9:12 p.m. UTC
* gnu/packages/python.scm (python-sqlalchemy-utils)[description]: Include
  optional dependencies.
---
 gnu/packages/python.scm | 14 +++++++++++++-
 1 file changed, 13 insertions(+), 1 deletion(-)

Comments

Hartmut Goebel Nov. 6, 2016, 10:07 p.m. UTC | #1
Am 06.11.2016 um 22:12 schrieb Danny Milosavljevic:
> * gnu/packages/python.scm (python-sqlalchemy-utils)[description]: Include
>   optional dependencies.
> ---
>  gnu/packages/python.scm | 14 +++++++++++++-
>  1 file changed, 13 insertions(+), 1 deletion(-)
>
> diff --git a/gnu/packages/python.scm b/gnu/packages/python.scm
> index 6b2c9e9..5b5287e 100644
> --- a/gnu/packages/python.scm
> +++ b/gnu/packages/python.scm
> @@ -4010,7 +4010,19 @@ both of which are installed automatically if you install this library.")
>      (synopsis "Various utility functions for SQLAlchemy")
>      (description
>       "SQLAlchemy-utils provides various utility functions and custom data types
> -for SQLAlchemy.  SQLAlchemy is an SQL database abstraction library for Python.")
> +for SQLAlchemy.  SQLAlchemy is an SQL database abstraction library for Python.
> +
> +You might also want to install the following optional dependencies:
> +@enumerate
> +@item @code{python-passlib}
> +@item @code{python-babel}
> +@item @code{python-cryptography}
> +@item @code{python-pytz}
> +@item @code{python-psycopg2}
> +@item @code{python-furl}
> +@item @code{python-flask-babel}
> +@end enumerate
> +")
>      (properties `((python2-variant . ,(delay python2-sqlalchemy-utils))))
>      (license license:bsd-3)))
>  
>

LGTM.
Leo Famulari Nov. 7, 2016, 5:53 p.m. UTC | #2
On Sun, Nov 06, 2016 at 10:12:53PM +0100, Danny Milosavljevic wrote:
> * gnu/packages/python.scm (python-sqlalchemy-utils)[description]: Include
>   optional dependencies.

I changed the commit message to include the name of the changed
packages and pushed. Thanks!

In the commit title, I used the package name 'python-sqlalchemy-utils',
and in the commit message I mentioned both the Python 2 and 3 variants
of the package.

It's important to follow these conventions. It makes it possible to see
the log of changes to a package by searching for 'gnu:
python-sqlalchemy-utils' in the Git log, and other tricks like that.
diff mbox

Patch

diff --git a/gnu/packages/python.scm b/gnu/packages/python.scm
index 6b2c9e9..5b5287e 100644
--- a/gnu/packages/python.scm
+++ b/gnu/packages/python.scm
@@ -4010,7 +4010,19 @@  both of which are installed automatically if you install this library.")
     (synopsis "Various utility functions for SQLAlchemy")
     (description
      "SQLAlchemy-utils provides various utility functions and custom data types
-for SQLAlchemy.  SQLAlchemy is an SQL database abstraction library for Python.")
+for SQLAlchemy.  SQLAlchemy is an SQL database abstraction library for Python.
+
+You might also want to install the following optional dependencies:
+@enumerate
+@item @code{python-passlib}
+@item @code{python-babel}
+@item @code{python-cryptography}
+@item @code{python-pytz}
+@item @code{python-psycopg2}
+@item @code{python-furl}
+@item @code{python-flask-babel}
+@end enumerate
+")
     (properties `((python2-variant . ,(delay python2-sqlalchemy-utils))))
     (license license:bsd-3)))