This is an archive of the discontinued Mercurial Phabricator instance.

Differential D1878

chistedit: make command's help text match hg style
ClosedPublic

Authored by spectral on Jan 17 2018, 5:22 PM.
Tags
None
Subscribers
None

Details

Reviewers
None
Group Reviewers
Restricted Project
Commits
rFBHGXe9cd2a76c492: chistedit: make command's help text match hg style
Summary

Currently if chistedit shows up in hg help (no arguments) output, it looks
like this, where it has multiple sentences, starts with a capital letter, and
takes up multiple lines:

chistedit     Provides a ncurses interface to histedit. Press ? in chistedit
              mode

With this change, I'm making it intentionally resemble histedit's text and it
looks like this:

histedit      interactively edit changeset history
chistedit     interactively edit changeset history via a curses interface

Similarly, if one runs hg help histedit, the first few lines look like this:

hg histedit [OPTIONS] ([ANCESTOR] | --outgoing [URL])

interactively edit changeset history

    This command lets you edit a linear series of changesets (up to and
    including the working directory, which should be clean). You can:

This change makes hg help chistedit look similar:

hg chistedit ANCESTOR

interactively edit changeset history via a curses interface

    Provides a ncurses interface to histedit. Press ? in chistedit mode to see
    an extensive help. Requires python-curses to be installed.

Diff Detail

Repository
rFBHGX Facebook Mercurial Extensions
Lint
Automatic diff as part of commit; lint not applicable.
Unit
Automatic diff as part of commit; unit tests not applicable.

Event Timeline

spectral created this revision.Jan 17 2018, 5:22 PM
Herald added a reviewer: Restricted Project. · View Herald TranscriptJan 17 2018, 5:22 PM
Closed by commit rFBHGXe9cd2a76c492: chistedit: make command's help text match hg style (authored by spectral). · Explain WhyJul 24 2018, 3:41 AM
This revision was automatically updated to reflect the committed changes.

Revision Contents
Changeset List

PathPackages
Mhgext3rd/chistedit.py (4 lines)

Diff 9653

hgext3rd/chistedit.py

testedwith = 'ships-with-fb-hgext' testedwith = 'ships-with-fb-hgext'
@command('chistedit', [ @command('chistedit', [
('k', 'keep', False, ('k', 'keep', False,
_("don't strip old nodes after edit is complete")), _("don't strip old nodes after edit is complete")),
('r', 'rev', [], _('first revision to be edited'))], ('r', 'rev', [], _('first revision to be edited'))],
_("ANCESTOR")) _("ANCESTOR"))
def chistedit(ui, repo, *freeargs, **opts): def chistedit(ui, repo, *freeargs, **opts):
"""Provides a ncurses interface to histedit. Press ? in chistedit mode """interactively edit changeset history via a curses interface
Provides a ncurses interface to histedit. Press ? in chistedit mode
to see an extensive help. Requires python-curses to be installed.""" to see an extensive help. Requires python-curses to be installed."""
if curses is None: if curses is None:
raise error.Abort(_("Python curses library required")) raise error.Abort(_("Python curses library required"))
# disable color # disable color
ui._colormode = None ui._colormode = None