Skip to content

Commit aef2004

Browse files
josixwilson-wang-appier
authored andcommitted
docs(BaseConfig): add elaboration on the mutated_settings property
1 parent c533e70 commit aef2004

File tree

1 file changed

+5
-0
lines changed

1 file changed

+5
-0
lines changed

commitizen/config/base_config.py

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -41,6 +41,11 @@ def settings(self) -> Settings:
4141

4242
@property
4343
def mutated_settings(self) -> Settings:
44+
"""It is used to record the changes from the config file defined by users,
45+
which helps distinguish the ambiguous default behavior of
46+
`changelog_incremental`.
47+
Please refer to https://github.com/commitizen-tools/commitizen/pull/996
48+
"""
4449
return self._settings_from_configs
4550

4651
@property

0 commit comments

Comments
 (0)