Skip to content

Commit

Permalink
Adjust changelog hook documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
noirbizarre committed Aug 24, 2013
1 parent 1b2ae0a commit f605577
Showing 1 changed file with 40 additions and 2 deletions.
42 changes: 40 additions & 2 deletions doc/hooks.rst
Original file line number Diff line number Diff line change
Expand Up @@ -65,7 +65,7 @@ The separator parameter spcify the character user to underline your changelog se
In development
~~~~~~~~~~~~~~
- No feature yet
- Another feature
Version 1.0.1 (2013-08-23)
~~~~~~~~~~~~~~~~~~~~~~~~~~
Expand All @@ -81,8 +81,46 @@ To handle this changelog you will have the following configuration
separator = ~
bump = Version {version} ({date:%Y-%m-%d})
prepare = In development
empty = No Feature yet
empty = Empty
If you execute Bump'R, the changelog will be bumped like:

.. code-block:: rst
Changelog
=========
Version 1.0.2 (2013-08-24)
~~~~~~~~~~~~~~~~~~~~~~~~~~
- Another feature
Version 1.0.1 (2013-08-23)
~~~~~~~~~~~~~~~~~~~~~~~~~~
- Some new feature
And then prepared:

.. code-block:: rst
Changelog
=========
In development
~~~~~~~~~~~~~~
- Empty
Version 1.0.2 (2013-08-24)
~~~~~~~~~~~~~~~~~~~~~~~~~~
- Another feature
Version 1.0.1 (2013-08-23)
~~~~~~~~~~~~~~~~~~~~~~~~~~
- Some new feature
Commands
--------
Expand Down

0 comments on commit f605577

Please sign in to comment.