Annikka/evennia
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Updated docstring for multimatch config settings.

Browse source
This commit is contained in:
Griatch 2016-11-17 12:52:30 +01:00
parent 2c6227774a
commit a20e7d017d
1 changed files with 9 additions and 9 deletions
Download patch file Download diff file Expand all files Collapse all files

18
evennia/settings_default.py
View file

@ -252,16 +252,16 @@ COMMAND_PARSER = "evennia.commands.cmdparser.cmdparser"
# the results. If multiple "box" objects # the results. If multiple "box" objects
# are found, they can by default be separated as 1-box, 2-box. Below you # are found, they can by default be separated as 1-box, 2-box. Below you
# can change the regular expression used. The regex must have one # can change the regular expression used. The regex must have one
# have two capturing groups (?P<prefix>...) and (?P<name>...) - the default # have two capturing groups (?P<number>...) and (?P<name>...) - the default
# parser expects this. It should # parser expects this. It should also involve a number starting from 1.
# also involve a number starting from 1. When changing this you must also # When changing this you must also update SEARCH_MULTIMATCH_TEMPLATE
# update SEARCH_MULTIMATCH_TEMPLATE to properly describe the syntax. # to properly describe the syntax.
SEARCH_MULTIMATCH_REGEX = r"(?P<number>[0-9]+)-(?P<name>.*)" SEARCH_MULTIMATCH_REGEX = r"(?P<number>[0-9]+)-(?P<name>.*)"
# To display multimatch errors we must display each multimatch in a way that # To display multimatch errors in various listings we must display
# instructs users to separate their multimatches in a way SEARCH_MULTIMATCH_REGEX # the syntax in a way that matches what SEARCH_MULTIMATCH_REGEX understand.
# above understands; for example by making sure they must write 1-box, 2-box etc. # The template will be populated with data and expects the following markup:
# The template must contain {number} - a number to separate multi-matches, starting # {number} - the order of the multimatch, starting from 1; {name} - the
# from 1; {name} - the name of the multimatched entity; {aliases} - eventual # name (key) of the multimatched entity; {aliases} - eventual
# aliases for the entity; {info} - extra info like #dbrefs for staff. Don't # aliases for the entity; {info} - extra info like #dbrefs for staff. Don't
# forget a line break if you want one match per line. # forget a line break if you want one match per line.
SEARCH_MULTIMATCH_TEMPLATE = " {number}-{name}{aliases}{info}\n" SEARCH_MULTIMATCH_TEMPLATE = " {number}-{name}{aliases}{info}\n"