D544: releasenotes: update docstrings with information on additional flags

[dsp (David Soria Parra)]

dsp added inline comments.

INLINE COMMENTS

> releasenotes.py:554
> +
> +    With the -c/--check option, you can check the commit message for an invalid
> +    admonition. In case of an invalid admonition, the flag returns the name of

I think we usually don't address "you" directly. Maybe something like

  The -c/--check option checks the commit message for invalid admonitions. In case of an invalid admonition, the flag returns the name of admonition along with the changeset ID. For example::

> releasenotes.py:563
> +    For the above commit message, using `hg releasenotes -r . --check`
> +    returns: Invalid admonition 'abcd' present in changeset 3ea92981e103:
> +

I think the colon at the end is invalid.

> releasenotes.py:565-566
> +
> +    Incase the invalid admonition is similar to the available admonitions upto
> +    a certain threshold it suggests the correct admonition to you. For example::
> +

If an invalid admonition is similar to the available admonitions upto
  a certain threshold, the correct admonition will be suggested.

REPOSITORY
  rHG Mercurial

REVISION DETAIL
  https://phab.mercurial-scm.org/D544

To: rishabhmadan96, #hg-reviewers
Cc: dsp, durin42, mercurial-devel