blob: d3cc2acaa01bdddd7f10026f34127e85845678ec [file] [log] [blame]
Bill Wendlingdcafd5f2015-09-12 15:26:03 -07001# Change Log
2# All notable changes to this project will be documented in this file.
3# This project adheres to [Semantic Versioning](http://semver.org/).
4
Bill Wendling4dc472d2016-04-10 03:03:55 -07005## [0.7.1] UNRELEASED
6### Fixed
7- Don't rewrite the file if there are no changes.
Bill Wendlingac00a252016-04-12 05:31:03 -07008- Ensure the proper number of blank lines before an async function.
Bill Wendlingc4a49652016-04-13 13:42:43 -07009- Split after a bitwise operator when in PEP 8 mode.
Bill Wendling423759f2016-04-14 21:14:20 -070010- Retain the splitting within a dictionary data literal between the key and
11 value.
Bill Wendling4dc472d2016-04-10 03:03:55 -070012
Bill Wendlingdefe5f32016-04-09 22:29:51 -070013## [0.7.0] 2016-04-09
Bill Wendling2e588512016-03-13 01:02:47 -080014### Added
Bill Wendling5758e4d2016-03-19 03:38:48 -070015- Support for Python 3.5.
16- Add 'ALLOW_MULTILINE_LAMBDAS' which allows lambdas to be formatted onto
17 multiple lines.
Bill Wendling2e588512016-03-13 01:02:47 -080018
19### Fixed
20- Lessen penalty for splitting before a dictionary keyword.
Bill Wendling90a2aa52016-03-20 02:25:13 -070021- Formatting of trailing comments on disabled formatting lines.
Bill Wendling2064d882016-04-09 22:21:15 -070022- Disable / enable formatting at end of multi-line comment.
Bill Wendling2e588512016-03-13 01:02:47 -080023
Bill Wendling0bca2aa2016-03-06 20:44:14 -080024## [0.6.3] 2016-03-06
25### Changed
26- Documentation updated.
27
Bill Wendling95e47b92015-11-04 22:58:30 -080028### Fixed
29- Fix spacing of multiline comments when formatting is disabled.
30
Bill Wendling9ffd8152015-11-01 17:49:25 -080031## [0.6.2] 2015-11-01
Bill Wendling6e8ca7b2015-10-25 01:16:43 -070032### Changed
33- Look at the 'setup.cfg' file to see if it contains style information for
34 YAPF.
Bill Wendling169790e2015-10-25 03:13:13 -070035- Look at the '~/.config/yapf/style' file to see if it contains global style
36 information for YAPF.
Bill Wendling6e8ca7b2015-10-25 01:16:43 -070037
Bill Wendling57ffbbb2015-10-25 00:20:14 -070038### Fixed
39- Make lists that can fit on one line more likely to stay together.
Bill Wendling5091fa62015-10-28 01:51:53 -070040- Correct formatting of '*args' and '**kwargs' when there are default values in
41 the argument list.
Bill Wendling57ffbbb2015-10-25 00:20:14 -070042
Bill Wendling348b2f32015-10-24 03:20:10 -070043## [0.6.1] 2015-10-24
Bill Wendling3a3cb6d2015-10-20 13:40:27 -070044### Fixed
45- Make sure to align comments in data literals correctly. Also make sure we
46 don't count a "#." in a string as an i18n comment.
Bill Wendlinga6b57a62015-10-20 13:57:52 -070047- Retain proper vertical spacing before comments in a data literal.
Bill Wendling843e48c2015-10-20 16:53:08 -070048- Make sure that continuations from a compound statement are distinguished from
49 the succeeding line.
Bill Wendling81e37b62015-10-21 13:18:29 -070050- Ignore preceding comments when calculating what is a "dictonary maker".
Bill Wendlinga5585722015-10-21 15:32:22 -070051- Add a small penalty for splitting before a closing bracket.
Bill Wendlingdbcf3422015-10-21 22:11:15 -070052- Ensure that a space is enforced after we remove a pseudo-paren that's between
53 two names, keywords, numbers, etc.
Bill Wendlingf8856722015-10-21 23:53:29 -070054- Increase the penalty for splitting after a pseudo-paren. This could lead to
55 less readable code in some circumstances.
Bill Wendling3a3cb6d2015-10-20 13:40:27 -070056
Bill Wendling7ef492b2015-10-18 14:43:06 -070057## [0.6.0] 2015-10-18
Bill Wendlinga5cef8e2015-10-15 21:42:03 -070058### Added
59- Add knob to indent the dictionary value if there is a split before it.
60
Bill Wendlingcec66962015-10-17 04:08:23 -070061### Changed
62- No longer check that a file is a "Python" file unless the '--recursive' flag
63 is specified.
64- No longer allow the user to specify a directory unless the '--recursive' flag
65 is specified.
66
Bill Wendlingc87690c2015-10-11 16:45:21 -070067### Fixed
68- When determining if we should split a dictionary's value to a new line, use
69 the longest entry instead of the total dictionary's length. This allows the
70 formatter to reformat the dictionary in a more consistent manner.
Bill Wendling0946c0f2015-10-12 00:42:30 -070071- Improve how list comprehensions are formatted. Make splitting dependent upon
72 whether the "comp_for" or "comp_if" goes over the column limit.
Bill Wendling43bdc7b2015-10-12 14:25:30 -070073- Don't over indent if expression hanging indents if we expect to dedent the
74 closing bracket.
Bill Wendlingc1052c62015-10-15 03:12:28 -070075- Improve splitting heuristic when the first argument to a function call is
76 itself a function call with arguments. In cases like this, the remaining
77 arguments to the function call would look badly aligned, even though they are
78 techincally correct (the best kind of correct!).
Bill Wendlingb1037b52015-10-15 22:38:19 -070079- Improve splitting heuristic more so that if the first argument to a function
80 call is a data literal that will go over the column limit, then we want to
81 split before it.
Bill Wendling8d8f5122015-10-16 11:46:23 -070082- Remove spaces around '**' operator.
Bill Wendlingf8325e62015-10-16 15:38:54 -070083- Retain formatting of comments in the middle of an expression.
Bill Wendling454cef62015-10-18 03:49:03 -070084- Don't add a newline to an empty file.
Bill Wendling7ef492b2015-10-18 14:43:06 -070085- Over indent a function's parameter list if it's not distinguished from the
86 body of the function.
Bill Wendlingc87690c2015-10-11 16:45:21 -070087
Bill Wendling2aff7fc2015-10-11 14:08:10 -070088## [0.5.0] 2015-10-11
Bill Wendlingd03c99f2015-10-08 21:06:07 -070089### Added
90- Add option to exclude files/directories from formatting.
Bill Wendling5c608732015-10-10 23:39:16 -070091- Add a knob to control whether import names are split after the first '('.
Bill Wendlingd03c99f2015-10-08 21:06:07 -070092
Bill Wendlinga7e3f502015-10-08 00:23:40 -070093### Fixed
94- Indent the continuation of an if-then statement when it's not distinguished
95 from the body of the if-then.
Bill Wendling1ce18c72015-10-10 23:12:16 -070096- Allow for sensible splitting of array indices where appropriate.
Bill Wendlingbe974d82015-10-11 01:04:00 -070097- Prefer to not split before the ending bracket of an atom. This produces
98 better code in most cases.
Bill Wendlingbbd148c2015-10-11 01:45:24 -070099- Corrected how horizontal spaces were presevered in a disabled region.
Bill Wendlinga7e3f502015-10-08 00:23:40 -0700100
Bill Wendling967c3b22015-10-07 22:20:18 -0700101## [0.4.0] 2015-10-07
Ɓukasz Langa94089872015-09-22 16:02:26 -0700102### Added
103- Support for dedenting closing brackets, "facebook" style.
104
Bill Wendling25c8e602015-10-04 20:48:35 -0700105### Fixed
106- Formatting of tokens after a multiline string didn't retain their horizontal
107 spacing.
108
Bill Wendling06865ab2015-09-30 01:25:47 -0700109## [0.3.1] 2015-09-30
110### Fixed
111- Format closing scope bracket correctly when indentation size changes.
112
Bill Wendlinga690a622015-09-20 12:38:50 -0700113## [0.3.0] 2015-09-20
114### Added
115- Return a 2 if the source changed, 1 on error, and 0 for no change.
116
117### Fixed
118- Make sure we format if the "lines" specified are in the middle of a
119 statement.
120
Bill Wendling9adfa0c2015-09-13 05:37:30 -0700121## [0.2.9] - 2015-09-13
122### Fixed
123- Formatting of multiple files. It was halting after formatting the first file.
124
Bill Wendlingdcafd5f2015-09-12 15:26:03 -0700125## [0.2.8] - 2015-09-12
126### Added
127- Return a non-zero exit code if the source was changed.
128- Add bitwise operator splitting penalty and prefer to split before bitwise
129 operators.
130
131### Fixed
132- Retain vertical spacing between disabled and enabled lines.
133- Split only at start of named assign.
134- Retain comment position when formatting is disabled.
135- Honor splitting before or after logical ops.