( )⚙ D7445 doc: don't use mutable default arguments

This is an archive of the discontinued Mercurial Phabricator instance.

Differential D7445

doc: don't use mutable default arguments
ClosedPublic

Authored by indygreg on Nov 16 2019, 3:08 PM.

Details

Reviewers
pulkit
Group Reviewers
hg-reviewers
Commits
rHG15cccbacd5ce: doc: don't use mutable default arguments
Summary

It appears our mutable default arguments checker doesn't find
arguments not on the first line of a function definition :(

The arguments aren't used, so the default value is irrelevant.

I found this when blackening this script in a future commit.

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.

Event Timeline

indygreg created this revision.Nov 16 2019, 3:08 PM
pulkit accepted this revision.Nov 18 2019, 11:11 AM
This revision is now accepted and ready to land.Nov 18 2019, 11:11 AM
indygreg added a commit: rHG15cccbacd5ce: doc: don't use mutable default arguments.Nov 18 2019, 11:49 AM
Closed by commit rHG15cccbacd5ce: doc: don't use mutable default arguments (authored by indygreg). · Explain Why
This revision was automatically updated to reflect the committed changes.

Revision Contents
Changeset List

PathPackages
Mdoc/runrst (3 lines)

Diff 18213

doc/runrst

import docutils.parsers.rst.roles as roles import docutils.parsers.rst.roles as roles
except ImportError: except ImportError:
sys.stderr.write("abort: couldn't generate documentation: docutils " sys.stderr.write("abort: couldn't generate documentation: docutils "
"module is missing\n") "module is missing\n")
sys.stderr.write("please install python-docutils or see " sys.stderr.write("please install python-docutils or see "
"http://docutils.sourceforge.net/\n") "http://docutils.sourceforge.net/\n")
sys.exit(-1) sys.exit(-1)
def role_hg(name, rawtext, text, lineno, inliner, def role_hg(name, rawtext, text, lineno, inliner, options=None, content=None):
options={}, content=[]):
text = "hg " + utils.unescape(text) text = "hg " + utils.unescape(text)
linktext = nodes.literal(rawtext, text) linktext = nodes.literal(rawtext, text)
parts = text.split() parts = text.split()
cmd, args = parts[1], parts[2:] cmd, args = parts[1], parts[2:]
refuri = "hg.1.html#%s" % cmd refuri = "hg.1.html#%s" % cmd
if cmd == 'help' and args: if cmd == 'help' and args:
if args[0] == 'config': if args[0] == 'config':
# :hg:`help config` # :hg:`help config`