From fbf67ea2dabee92be756c3abea5a5b42165f4715 Mon Sep 17 00:00:00 2001
From: Adar Nimrod <nimrod@shore.co.il>
Date: Wed, 11 Aug 2021 16:35:49 +0300
Subject: [PATCH] Reword the dependencies paragraph.
Make it more explicit, set a release that will break backward
compatibility. Also, disable the proselint pre-commit hook, it can't
skip code blocks and there's not a lot I can do about that.
---
.pre-commit-config.yaml | 7 -------
README.rst | 13 +++++++------
2 files changed, 7 insertions(+), 13 deletions(-)
diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml
index c292ffd..0a92774 100644
--- a/.pre-commit-config.yaml
+++ b/.pre-commit-config.yaml
@@ -19,13 +19,6 @@ repos:
hooks:
- id: yamllint
- - repo: https://github.com/amperser/proselint/
- rev: 0.11.3
- hooks:
- - id: proselint
- types: [plain-text]
- exclude: LICENSE
-
- repo: https://github.com/ambv/black
rev: 21.7b0
hooks:
diff --git a/README.rst b/README.rst
index ac2e132..d60fbe0 100644
--- a/README.rst
+++ b/README.rst
@@ -42,10 +42,11 @@ Installation
This will install Template along with the dependencies for all of the filters
available with it. However, you can use narrower specifiers if you want to avoid
a specific dependency (the filters listed below include the needed specifier).
-In previous versions of Template all of the dependencies were required, so to
-avoid breakage this behavior will be be kept. However, this will change in a
-later release so to the keep the expected behavior please update your project's
-dependencies.
+In previous releases of Template all of the dependencies were required. To not
+break existing templates, for the foreseeable future those dependencies will
+remain a requirement and new dependencies for specific filters will be optional.
+This will change in the 0.9 release where all filter specific dependencies will
+be optional. Please update your project before that happens.
Examples
@@ -64,8 +65,8 @@ Examples
optional arguments:
-h, --help show this help message and exit
- -o OUTPUT, --output OUTPUT
- Output to filename
+ -o OUTPUT, --output OUTPUT
+ Output to filename
$ export name='John'
$ echo 'Hello {{ name if name is defined else 'world' }}. | template
Hello John.
--
GitLab