This patch adds documentation related to the two new flags --check and
--list for releasenotes extension.
Details
- Reviewers
krbullock yuja - Group Reviewers
hg-reviewers - Commits
- rHG01e8ab4b6573: releasenotes: update docstrings with information on additional flags
Diff Detail
- Repository
- rHG Mercurial
- Lint
Lint Skipped - Unit
Unit Tests Skipped
Event Timeline
hgext/releasenotes.py | ||
---|---|---|
555 | It's just the same thing. I'll replace incorrect with invalid. |
hgext/releasenotes.py | ||
---|---|---|
554 | 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:: | |
563 | I think the colon at the end is invalid. | |
565–566 | If an invalid admonition is similar to the available admonitions upto a certain threshold, the correct admonition will be suggested. |
hgext/releasenotes.py | ||
---|---|---|
556–575 | I don't think these examples are necessary in the help text—it's sufficient to simply say "...checks the commit message for invalid admonitions." |
nit: "With the" instead of "With", "an" instead of "any"