Skip to content

Commit

Permalink
Disable docformatter for now
Browse files Browse the repository at this point in the history
Storing example responses in docstrings is dumb, but there is no nice way
to keep it on while avoiding formatting that makes them incomprehensible like:

-        """
-        Response of Yeelight Dual Control Module
-        {
-            'id': 1,
-            'result': [
-                {'did': 'switch_1_state', 'siid': 2, 'piid': 1, 'code': 0, 'value': False},
-                {'did': 'switch_1_default_state', 'siid': 2, 'piid': 2, 'code': 0, 'value': True},
-                {'did': 'switch_1_off_delay', 'siid': 2, 'piid': 3, 'code': 0, 'value': 300},
-                {'did': 'switch_2_state', 'siid': 3, 'piid': 1, 'code': 0, 'value': False},
-                {'did': 'switch_2_default_state', 'siid': 3, 'piid': 2, 'code': 0, 'value': False},
-                {'did': 'switch_2_off_delay', 'siid': 3, 'piid': 3, 'code': 0, 'value': 0},
-                {'did': 'interlock', 'siid': 4, 'piid': 1, 'code': 0, 'value': False},
-                {'did': 'flex_mode', 'siid': 4, 'piid': 2, 'code': 0, 'value': True},
-                {'did': 'rc_list', 'siid': 4, 'piid': 2, 'code': 0, 'value': '[{"mac":"9db0eb4124f8","evtid":4097,"pid":339,"beaconkey":"3691bc0679eef9596bb63abf"}]'},
-            ]
-        }
-        """
+        """Response of Yeelight Dual Control Module { 'id': 1, 'result': [ {'did':
+        'switch_1_state', 'siid': 2, 'piid': 1, 'code': 0, 'value': False}, {'did':
+        'switch_1_default_state', 'siid': 2, 'piid': 2, 'code': 0, 'value': True},
+        {'did': 'switch_1_off_delay', 'siid': 2, 'piid': 3, 'code': 0, 'value': 300},
+        {'did': 'switch_2_state', 'siid': 3, 'piid': 1, 'code': 0, 'value': False},
+        {'did': 'switch_2_default_state', 'siid': 3, 'piid': 2, 'code': 0, 'value':
+        False}, {'did': 'switch_2_off_delay', 'siid': 3, 'piid': 3, 'code': 0, 'value':
+        0}, {'did': 'interlock', 'siid': 4, 'piid': 1, 'code': 0, 'value': False},
+        {'did': 'flex_mode', 'siid': 4, 'piid': 2, 'code': 0, 'value': True}, {'did':
+        'rc_list', 'siid': 4, 'piid': 2, 'code': 0, 'value': '[{"mac":"9db0eb4124f8","ev
+        tid":4097,"pid":339,"beaconkey":"3691bc0679eef9596bb63abf"}]'}, ] }"""

Somewhat related to PyCQA/docformatter#144
  • Loading branch information
rytilahti committed Oct 21, 2023
1 parent 8ef8837 commit 1273404
Showing 1 changed file with 5 additions and 5 deletions.
10 changes: 5 additions & 5 deletions .pre-commit-config.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -29,11 +29,11 @@ repos:
# - id: doc8
# additional_dependencies: [myst-parser]

- repo: https://github.com/myint/docformatter
rev: v1.7.5
hooks:
- id: docformatter
args: [--in-place, --wrap-summaries, '88', --wrap-descriptions, '88']
# - repo: https://github.com/myint/docformatter
# rev: v1.7.5
# hooks:
# - id: docformatter
# args: [--in-place, --wrap-summaries, '88', --wrap-descriptions, '88', --black

- repo: https://github.com/pycqa/flake8
rev: 6.1.0
Expand Down

0 comments on commit 1273404

Please sign in to comment.