( )⚙ D9988 gendoc: support defaults on customopts a bit better

This is an archive of the discontinued Mercurial Phabricator instance.

Differential D9988

gendoc: support defaults on customopts a bit better
ClosedPublic

Authored by spectral on Feb 12 2021, 3:05 PM.

Details

Reviewers
pulkit
Group Reviewers
hg-reviewers
Commits
rHG921e1253c8ba: gendoc: support defaults on customopts a bit better
Summary

Without this, a customopt will very likely render like this:

-foo   does foo (default: <hgext.myextension.MyOpt object at 0x7f31...>)

I copied this logic from how this is handled in mercurial/help.py.

Diff Detail

Repository
rHG Mercurial
Branch
default
Lint
No Linters Available
Unit
No Unit Test Coverage

Event Timeline

spectral created this revision.Feb 12 2021, 3:05 PM
pulkit accepted this revision.Feb 14 2021, 10:15 AM
This revision is now accepted and ready to land.Feb 14 2021, 10:15 AM
spectral added a commit: rHG921e1253c8ba: gendoc: support defaults on customopts a bit better.Feb 14 2021, 11:05 AM
Closed by commit rHG921e1253c8ba: gendoc: support defaults on customopts a bit better (authored by spectral). · Explain Why
This revision was automatically updated to reflect the committed changes.

Revision Contents
Changeset List

PathPackages
Mdoc/gendoc.py (3 lines)

Diff 25611

doc/gendoc.py

from mercurial import demandimport from mercurial import demandimport
demandimport.enable() demandimport.enable()
from mercurial import ( from mercurial import (
commands, commands,
encoding, encoding,
extensions, extensions,
fancyopts,
help, help,
minirst, minirst,
pycompat, pycompat,
ui as uimod, ui as uimod,
) )
from mercurial.i18n import ( from mercurial.i18n import (
gettext, gettext,
_, _,
allopts.append(b"--%s" % longopt) allopts.append(b"--%s" % longopt)
if isinstance(default, list): if isinstance(default, list):
allopts[-1] += b" <%s[+]>" % optlabel allopts[-1] += b" <%s[+]>" % optlabel
elif (default is not None) and not isinstance(default, bool): elif (default is not None) and not isinstance(default, bool):
allopts[-1] += b" <%s>" % optlabel allopts[-1] += b" <%s>" % optlabel
if b'\n' in desc: if b'\n' in desc:
# only remove line breaks and indentation # only remove line breaks and indentation
desc = b' '.join(l.lstrip() for l in desc.split(b'\n')) desc = b' '.join(l.lstrip() for l in desc.split(b'\n'))
if isinstance(default, fancyopts.customopt):
default = default.getdefaultvalue()
if default: if default:
default = stringutil.forcebytestr(default) default = stringutil.forcebytestr(default)
desc += _(b" (default: %s)") % default desc += _(b" (default: %s)") % default
yield (b", ".join(allopts), desc) yield (b", ".join(allopts), desc)
def get_cmd(cmd, cmdtable): def get_cmd(cmd, cmdtable):
d = {} d = {}