Auto merge of #4409 - jeremystucki:export, r=phansch

[Doc] Ignore lines starting with #

Resolves #4353

changelog: none
This commit is contained in:
bors 2019-08-23 11:51:50 +00:00
commit 56f51b35e8

View file

@ -10,6 +10,7 @@ import json
from lintlib import parse_all, log
lint_subheadline = re.compile(r'''^\*\*([\w\s]+?)[:?.!]?\*\*(.*)''')
rust_code_block = re.compile(r'''```rust.+?```''', flags=re.DOTALL)
CONF_TEMPLATE = """\
This lint has the following configuration variables:
@ -17,6 +18,16 @@ This lint has the following configuration variables:
* `%s: %s`: %s (defaults to `%s`)."""
def parse_code_block(match):
lines = []
for line in match.group(0).split('\n'):
if not line.startswith('# '):
lines.append(line)
return '\n'.join(lines)
def parse_lint_def(lint):
lint_dict = {}
lint_dict['id'] = lint.name
@ -44,7 +55,7 @@ def parse_lint_def(lint):
lint_dict['docs'][last_section] += text + "\n"
for section in lint_dict['docs']:
lint_dict['docs'][section] = lint_dict['docs'][section].strip()
lint_dict['docs'][section] = re.sub(rust_code_block, parse_code_block, lint_dict['docs'][section].strip())
return lint_dict