This is an archive of the discontinued Mercurial Phabricator instance.

Differential D6442

help: include subtopic in error message if passed
ClosedPublic

Authored by ngoldbaum on May 23 2019, 11:36 AM.

Details

Reviewers
pulkit
Group Reviewers
hg-reviewers
Commits
rHGad55a0a5894f: help: include subtopic in error message if passed
Summary

Diff Detail

Repository
rHG Mercurial
Lint
Lint Skipped
Unit
Unit Tests Skipped

Event Timeline

ngoldbaum created this revision.May 23 2019, 11:36 AM
av6 added a subscriber: av6.May 24 2019, 9:06 AM
av6 added inline comments.
mercurial/help.py
826

Concatenating things is not the best option when it comes to i18n, but even if it were, I think it would make sense to only show here the subtopic, if it's provided. If people are curious about internals.foobar (or config.foobar), then hg help -k foobar helps way more than hg help -k internals. And we already make sure that the topic that comes before the dot exists, right?

ngoldbaum added inline comments.May 24 2019, 9:20 AM
mercurial/help.py
826

Fair enough, I agree just the subtopic is fine.

ngoldbaum updated this revision to Diff 15253.May 24 2019, 9:28 AM
ngoldbaum updated this revision to Diff 15259.May 25 2019, 7:54 AM
ngoldbaum updated this revision to Diff 15269.May 26 2019, 5:06 PM
pulkit accepted this revision.May 29 2019, 1:24 PM
Closed by commit rHGad55a0a5894f: help: include subtopic in error message if passed (authored by ngoldbaum). · Explain WhyMay 29 2019, 1:35 PM
This revision was automatically updated to reflect the committed changes.

Revision Contents
Changeset List

PathPackages
Mmercurial/help.py (12 lines)
Mtests/test-help.t (7 lines)

Diff 15247

mercurial/help.py

def sub(m): def sub(m):
lines = [m.group(1) + s for s in repl.splitlines()] lines = [m.group(1) + s for s in repl.splitlines()]
return '\n'.join(lines) return '\n'.join(lines)
return re.sub(br'( *)%s' % re.escape(marker), sub, doc) return re.sub(br'( *)%s' % re.escape(marker), sub, doc)
addtopichook('config', inserttweakrc) addtopichook('config', inserttweakrc)
def help_(ui, commands, name, unknowncmd=False, full=True, subtopic=None, def help_(ui, commands, name, unknowncmd=False, full=True, subtopic=None,
**opts): fullname=None, **opts):
''' '''
Generate the help for 'name' as unformatted restructured text. If Generate the help for 'name' as unformatted restructured text. If
'name' is None, describe the commands available. 'name' is None, describe the commands available.
''' '''
opts = pycompat.byteskwargs(opts) opts = pycompat.byteskwargs(opts)
def helpcmd(name, subtopic=None): def helpcmd(name, subtopic=None):
rst = f(name, subtopic) rst = f(name, subtopic)
break break
except error.UnknownCommand: except error.UnknownCommand:
pass pass
else: else:
if unknowncmd: if unknowncmd:
raise error.UnknownCommand(name) raise error.UnknownCommand(name)
else: else:
msg = _('no such help topic: %s') % name if fullname:
formatname = fullname
else:
formatname = name
msg = _('no such help topic: %s') % formatname
hint = _("try 'hg help --keyword %s'") % name hint = _("try 'hg help --keyword %s'") % name
if subtopic:
hint += _(" or 'hg help --keyword %s'") % subtopic
av6Unsubmitted
Not Done

Concatenating things is not the best option when it comes to i18n, but even if it were, I think it would make sense to only show here the subtopic, if it's provided. If people are curious about internals.foobar (or config.foobar), then hg help -k foobar helps way more than hg help -k internals. And we already make sure that the topic that comes before the dot exists, right?

av6: Concatenating things is not the best option when it comes to i18n, but even if it were, I think…
ngoldbaumAuthorUnsubmitted
Not Done

Fair enough, I agree just the subtopic is fine.

ngoldbaum: Fair enough, I agree just the subtopic is fine.
raise error.Abort(msg, hint=hint) raise error.Abort(msg, hint=hint)
else: else:
# program name # program name
if not ui.quiet: if not ui.quiet:
rst = [_("Mercurial Distributed SCM\n"), '\n'] rst = [_("Mercurial Distributed SCM\n"), '\n']
rst.extend(helplist(None, **pycompat.strkwargs(opts))) rst.extend(helplist(None, **pycompat.strkwargs(opts)))
return ''.join(rst) return ''.join(rst)
subtopic = nameparts.pop(0) subtopic = nameparts.pop(0)
if nameparts: if nameparts:
section = encoding.lower('.'.join(nameparts)) section = encoding.lower('.'.join(nameparts))
textwidth = ui.configint('ui', 'textwidth') textwidth = ui.configint('ui', 'textwidth')
termwidth = ui.termwidth() - 2 termwidth = ui.termwidth() - 2
if textwidth <= 0 or termwidth < textwidth: if textwidth <= 0 or termwidth < textwidth:
textwidth = termwidth textwidth = termwidth
text = help_(ui, commands, name, text = help_(ui, commands, name, fullname=fullname,
subtopic=subtopic, unknowncmd=unknowncmd, full=full, **opts) subtopic=subtopic, unknowncmd=unknowncmd, full=full, **opts)
blocks, pruned = minirst.parse(text, keep=keep) blocks, pruned = minirst.parse(text, keep=keep)
if 'verbose' in pruned: if 'verbose' in pruned:
keep.append('omitted') keep.append('omitted')
else: else:
keep.append('notomitted') keep.append('notomitted')
blocks, pruned = minirst.parse(text, keep=keep) blocks, pruned = minirst.parse(text, keep=keep)

tests/test-help.t

| | | | | | | |
+------------------------------------------------------+ +------------------------------------------------------+
That is, a *chunk* consisting of the filename (not terminated or padded) That is, a *chunk* consisting of the filename (not terminated or padded)
followed by N chunks constituting the *delta group* for this file. The followed by N chunks constituting the *delta group* for this file. The
*empty chunk* at the end of each *delta group* denotes the boundary to the *empty chunk* at the end of each *delta group* denotes the boundary to the
next filelog sub-segment. next filelog sub-segment.
non-existent subtopics print an error
$ hg help internals.foo
abort: no such help topic: internals.foo
(try 'hg help --keyword internals' or 'hg help --keyword foo')
[255]
test advanced, deprecated and experimental options are hidden in command help test advanced, deprecated and experimental options are hidden in command help
$ hg help debugoptADV $ hg help debugoptADV
hg debugoptADV hg debugoptADV
(no help text available) (no help text available)
options: options: