This is an archive of the discontinued Mercurial Phabricator instance.

Differential D545

releasenotes: update docstrings with information on additional flags
AbandonedPublic

Authored by rishabhmadan96 on Aug 28 2017, 4:11 PM.

Details

Reviewers
None
Group Reviewers
hg-reviewers
Summary

This patch adds documentation related to the two new flags --check and
--list for releasenotes extension.

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

Diff Detail

Repository
rHG Mercurial
Lint
Lint Skipped
Unit
Unit Tests Skipped

Revision Contents
Changeset List

PathPackages
Mhgext/releasenotes.py (26 lines)

Diff 1367

hgext/releasenotes.py

* Duplicate items are automatically ignored * Duplicate items are automatically ignored
* Items that are different are automatically ignored if the similarity is * Items that are different are automatically ignored if the similarity is
greater than a threshold. greater than a threshold.
This means that the release notes file can be updated independently from This means that the release notes file can be updated independently from
this command and changes should not be lost when running this command on this command and changes should not be lost when running this command on
that file. A particular use case for this is to tweak the wording of a that file. A particular use case for this is to tweak the wording of a
release note after it has been added to the release notes file. release note after it has been added to the release notes file.
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
admonition along with the changeset ID. For example::
.. abcd::
First paragraph under this admonition
For the above commit message, using `hg releasenotes -r . --check`
returns: Invalid admonition 'abcd' present in changeset 3ea92981e103:
Incase the invalid admonition is similar to the available admonitions upto
a certain threshold it suggests the correct admonition to you. For example::
.. fixes::
Fixes issue1234
For the above commit message, using `hg releasenotes -r . --check`
returns: Invalid admonition 'fixes' present in changeset 687be3ff87c6
(did you mean fix?)
With the -l/--list option, you will be presented with a list of the
existing available admonitions along with their title. This also includes
the custom admonitions (if any).
""" """
sections = releasenotessections(ui, repo) sections = releasenotessections(ui, repo)
if opts.get('list'): if opts.get('list'):
return _getadmonitionlist(ui, sections) return _getadmonitionlist(ui, sections)
rev = opts.get('rev') rev = opts.get('rev')
revs = scmutil.revrange(repo, [rev or 'not public()']) revs = scmutil.revrange(repo, [rev or 'not public()'])
if opts.get('check'): if opts.get('check'):