Skip to content

Commit

Permalink
update README.rst and CHANGELOG
Browse files Browse the repository at this point in the history
  • Loading branch information
ethanfurman committed Nov 14, 2019
1 parent fe8d3d9 commit 4624511
Show file tree
Hide file tree
Showing 2 changed files with 25 additions and 1 deletion.
3 changes: 3 additions & 0 deletions CHANGELOG
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,9 @@
### Added
- Add the `--quiet` flag to suppress output. The return code is 1 if there are
changes, similarly to the `--diff` flag.
- Add the `indent_closing_brackets` option. This is the same as the
`dedent_closing_brackets` option except the brackets are indented the same
as the previous line.
### Changed
- Collect a parameter list into a single object. This allows us to track how a
parameter list is formatted, keeping state along the way. This helps when
Expand Down
23 changes: 22 additions & 1 deletion README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -394,7 +394,8 @@ Knobs
``COALESCE_BRACKETS``
Do not split consecutive brackets. Only relevant when
``DEDENT_CLOSING_BRACKETS`` is set. For example:
``DEDENT_CLOSING_BRACKETS`` or ``INDENT_CLOSING_BRACKETS``
is set. For example:

.. code-block:: python
Expand Down Expand Up @@ -492,6 +493,26 @@ Knobs
``INDENT_BLANK_LINES``
Set to ``True`` to prefer indented blank lines rather than empty

``INDENT_CLOSING_BRACKETS``
Put closing brackets on a separate line, indented, if the bracketed
expression can't fit in a single line. Applies to all kinds of brackets,
including function definitions and calls. For example:

.. code-block:: python
config = {
'key1': 'value1',
'key2': 'value2',
} # <--- this bracket is indented and on a separate line
time_series = self.remote_client.query_entity_counters(
entity='dev3246.region1',
key='dns.query_latency_tcp',
transform=Transformation.AVERAGE(window=timedelta(seconds=60)),
start_ts=now()-timedelta(days=3),
end_ts=now(),
) # <--- this bracket is indented and on a separate line
``JOIN_MULTIPLE_LINES``
Join short lines into one line. E.g., single line ``if`` statements.

Expand Down

0 comments on commit 4624511

Please sign in to comment.