releasenotes: update docstrings with information on additional flags
ClosedPublic

Authored by rishabhmadan96 on Aug 28 2017, 2:57 PM.

Details

Summary

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

Diff Detail

Repository
rHG Mercurial
Lint
Automatic diff as part of commit; lint not applicable.
Unit
Automatic diff as part of commit; unit tests not applicable.
rishabhmadan96 created this revision.Aug 28 2017, 2:57 PM
durin42 added inline comments.
hgext/releasenotes.py
554

nit: "With the" instead of "With", "an" instead of "any"

555

I'm not sure what the difference is between incorrect and invalid?

rishabhmadan96 added inline comments.Aug 28 2017, 4:05 PM
hgext/releasenotes.py
555

It's just the same thing. I'll replace incorrect with invalid.

dsp added a subscriber: dsp.Sep 8 2017, 2:43 PM
dsp added inline comments.
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.
rishabhmadan96 added inline comments.Sep 10 2017, 1:24 PM
hgext/releasenotes.py
554

I referred the patchbomb.py file while writing this part, and it made use of 'you' and 'your'.
But I guess it's okay to have it without usage of 'you'. So I'll make the changes here.

563

My bad! I'll correct this one.

krbullock requested changes to this revision.Sep 18 2017, 3:50 PM
krbullock added a subscriber: krbullock.
krbullock added inline comments.
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."

This revision now requires changes to proceed.Sep 18 2017, 3:50 PM
yuja accepted this revision.Sep 30 2017, 2:14 AM
yuja added a subscriber: yuja.

Looks every nit is addressed. Queued, thanks.

This revision was automatically updated to reflect the committed changes.