File: Sphinx-Correct-multi-line-definition-list.patch

package info (click to toggle)
python-django-crispy-forms 2.4-1
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid, trixie
  • size: 1,056 kB
  • sloc: python: 3,078; makefile: 88
file content (31 lines) | stat: -rw-r--r-- 1,475 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
From: Carsten Schoenert <c.schoenert@t-online.de>
Date: Thu, 27 Jan 2022 08:29:47 +0100
Subject: Sphinx: Correct multi line definition list

Adjust the comment for optgroups(field) so Sphinx is happy with the
rst format and the output is generating content that is more useful.

/build/python-django-crispy-forms-1.14.0/crispy_forms/templatetags/crispy_forms_filters.py:docstring of templatetags.crispy_forms_filters.optgroups:11: WARNING: Definition list ends without a blank line; unexpected unindent.
/build/python-django-crispy-forms-1.14.0/crispy_forms/templatetags/crispy_forms_filters.py:docstring of templatetags.crispy_forms_filters.optgroups:12: WARNING: Definition list ends without a blank line; unexpected unindent.
---
 crispy_forms/templatetags/crispy_forms_filters.py | 7 +++----
 1 file changed, 3 insertions(+), 4 deletions(-)

--- a/crispy_forms/templatetags/crispy_forms_filters.py
+++ b/crispy_forms/templatetags/crispy_forms_filters.py
@@ -128,13 +128,12 @@
     """
     A template filter to help rendering of fields with optgroups.
 
-    Returns:
-        A tuple of label, option, index
+    Returns a tuple of label, option, index::
 
         label: Group label for grouped optgroups (`None` if inputs are not
                grouped).
 
-        option: A dict containing information to render the option::
+        option: A dict containing information to render the option:
 
             {
                 "name": "checkbox_select_multiple",