Skip to content

docs: Improve error message for docs #14817

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
yanavlasov merged 1 commit into from
Jan 26, 2021
Merged

docs: Improve error message for docs #14817

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 3 additions & 2 deletions tools/code_format/check_format.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -523,8 +523,9 @@ def reportError(message):
match = VERSION_HISTORY_NEW_LINE_REGEX.match(line)
if not match:
reportError("Version history line malformed. "
"Does not match VERSION_HISTORY_NEW_LINE_REGEX in check_format.py\n %s" %
line)
"Does not match VERSION_HISTORY_NEW_LINE_REGEX in check_format.py\n %s\n"
"Please use messages in the form 'category: feature explanation.', "
"starting with a lower-cased letter and ending with a period." % line)
else:
first_word = match.groups()[0]
next_word = match.groups()[1]
Expand Down