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