Skip to content

Commit

Permalink
doc: updated doc with new ParsedCommit object instead of nested Tuple
Browse files Browse the repository at this point in the history
  • Loading branch information
plup authored and danth committed Apr 11, 2020
1 parent 0285de2 commit ac565dc
Showing 1 changed file with 3 additions and 2 deletions.
5 changes: 3 additions & 2 deletions docs/commit-log-parsing.rst
Expand Up @@ -25,9 +25,10 @@ If you think this is all well and cool, but the angular style is not for you.
No need to worry because custom parsers are supported. A parser is basically
a python function that takes the commit message as the only argument and
returns a tuple with the information needed to evaluate the commit and build
the changelog. The format of the output should be as follows::
the changelog. The format of the output should be a `ParsedCommit` object with
the following parameters::

(level to bump, type of change, scope of change, (subject, body, footer))
ParsedCommit(level to bump, type of change, scope of change, (subject, body, footer))

The type of change can be one of `feature`, `fix` or any string in lowercase.
The `feature` will result in an minor release and `fix` or `perf` indicates a patch release.
Expand Down

0 comments on commit ac565dc

Please sign in to comment.