Skip to content

Improve unexpected error message when build fails #4754

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
merged 3 commits into from
Nov 1, 2018
Merged

Improve unexpected error message when build fails #4754

Show file tree
Hide file tree
Changes from 2 commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
e8d1373
Improve unexpected error message when build fails
dojutsu-user Oct 13, 2018
85cc350
Fix tests for doc_building
dojutsu-user Oct 13, 2018
6d7073e
Correct the grammar of the message
dojutsu-user Oct 15, 2018
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
4 changes: 3 additions & 1 deletion readthedocs/doc_builder/exceptions.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,9 @@ class BuildEnvironmentError(BuildEnvironmentException):

GENERIC_WITH_BUILD_ID = ugettext_noop(
'There was a problem with Read the Docs while building your documentation. '
'Please report this to us with your build id ({build_id}).',
'Please try again later. '
'However, if this problem persists, '
'please report to us with your build id ({build_id}).',
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I said "please report this to us".

I'm not sure if that was important for the grammar, but I just wanted to mention it.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

okay.... that looks more good to me too.

)


Expand Down
9 changes: 5 additions & 4 deletions readthedocs/rtd_tests/tests/test_doc_building.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -339,7 +339,8 @@ def test_failing_execution_with_unexpected_exception(self):
'length': mock.ANY,
'error': (
'There was a problem with Read the Docs while building your '
'documentation. Please report this to us with your build id (123).'
'documentation. Please try again later. However, if this '
'problem persists, please report to us with your build id (123).'
),
'setup': '',
'output': '',
Expand Down Expand Up @@ -485,9 +486,9 @@ def _inner():
'exit_code': 1,
'length': 0,
'error': (
"There was a problem with Read the Docs while building your "
"documentation. Please report this to us with your build id "
"(123)."
'There was a problem with Read the Docs while building your '
'documentation. Please try again later. However, if this '
'problem persists, please report to us with your build id (123).'
),
'setup': '',
'output': '',
Expand Down