diff options
author | Pierre Sassoulas <pierre.sassoulas@gmail.com> | 2019-06-10 10:37:32 +0200 |
---|---|---|
committer | Claudiu Popa <pcmanticore@gmail.com> | 2019-06-20 14:09:59 +0200 |
commit | 30ba9f4756ed67d6779105b4ee741269501906c2 (patch) | |
tree | ffca130eb052d3dc6b058ab0ffdc2dcdd311752f /pylint/utils/utils.py | |
parent | 8c30d86abc66f4e5003b01055ec398d6589a6007 (diff) | |
download | pylint-git-30ba9f4756ed67d6779105b4ee741269501906c2.tar.gz |
Refactor - Clearer function name ('rest' -> 'rst') in utils
I used the old name but there was probably a typo in it, as the format is
called rst.
Diffstat (limited to 'pylint/utils/utils.py')
-rw-r--r-- | pylint/utils/utils.py | 10 |
1 files changed, 5 insertions, 5 deletions
diff --git a/pylint/utils/utils.py b/pylint/utils/utils.py index c2216575f..81cbc3448 100644 --- a/pylint/utils/utils.py +++ b/pylint/utils/utils.py @@ -51,16 +51,16 @@ def category_id(cid): return MSG_TYPES_LONG.get(cid) -def get_rest_title(title, character): - """Permit to get a rest title underlined with a choosen character.""" +def get_rst_title(title, character): + """Permit to get a title formatted as ReStructuredText test (underlined with a chosen character).""" return "%s\n%s\n" % (title, character * len(title)) -def rest_format_section(section, options, doc=None): - """format an options section using as ReST formatted output""" +def get_rst_section(section, options, doc=None): + """format an options section using as a ReStructuredText formatted output""" result = "" if section: - result += get_rest_title(section, "'") + result += get_rst_title(section, "'") if doc: formatted_doc = normalize_text(doc, line_len=79, indent="") result += "%s\n\n" % formatted_doc |