You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
' PEP_257_4.1',' Should fit on a single line.',' Convention',' Should',' Yes'
159
159
' PEP_257_4.2',' Use triple quotes.',' Convention',' Shall',' Yes'
160
160
' PEP_257_4.3',' Closing quotes are on the same line as opening quotes.',' Convention',' Shall',' Yes'
161
161
' PEP_257_4.4',' No blank line before or after the docstring.',' Convention',' Shall',' Yes'
162
162
' PEP_257_4.5',' Is a phrase ending in a period.',' Convention',' Shall',' Yes'
163
163
' docformatter_4.5.1', ' One-line docstrings may end in any of the following punctuation marks [. ! ?]', ' Derived', ' May', ' Yes'
164
-
' docformatter_4.5.1', ' One-line docstrings will have the first word capitalized.', ' Derived', ' Shall', ' No'
164
+
' docformatter_4.5.2', ' One-line docstrings will have the first word capitalized.', ' Derived', ' Shall', ' Yes'
165
+
' docformatter_4.5.2.1', ' First words in one-line docstrings that are variables or filenames shall remain unchanged.', ' Derived', ' Shall', ' Yes [PR #185, #188]'
166
+
' docformatter_4.5.3', ' Shall not place a newline after the first line of a wrapped one-line docstring.' ' Derived', ' Shall', ' Yes [PR #179]'
165
167
' PEP_257_5','**Multi-line docstrings:**'
166
168
' PEP_257_5.1',' A summary is just like a one-line docstring.',' Convention',' Shall',' Yes'
167
169
' docformatter_5.1.1', ' The summary line shall satisfy all the requirements of a one-line docstring.', ' Derived', ' Shall', ' Yes'
@@ -196,6 +198,7 @@ the requirement falls in, the type of requirement, and whether
196
198
' docformatter_10.1.2', ' Should allow/disallow wrapping of one-line docstrings.', ' Derived', ' Should', ' No'
197
199
' docformatter_10.1.3', ' Shall not wrap links that exceed the wrap length.', ' Derived', ' Shall', ' Yes [*PR #114*]'
198
200
' docformatter_10.1.3.1', ' Shall maintain in-line links on one line even if the resulting line exceeds wrap length.', ' Derived', ' Shall', ' Yes [*PR #152*]'
201
+
' docformatter_10.1.3.2', ' Shall not place a newline between description text and a wrapped link.', ' Derived', ' Shall', ' Yes [PR #182]'
199
202
' docformatter_10.2', ' Should format docstrings using NumPy style.', ' Style', ' Should', ' No'
200
203
' docformatter_10.3', ' Should format docstrings using Google style.', ' Style', ' Should', ' No'
201
204
' docformatter_10.4', ' Should format docstrings using Sphinx style.',' Style', ' Should', ' No'
0 commit comments