Add interactive docs error template #5548
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
carltongibson
force-pushed
the
372/doc-error-rendering
branch
from
3e9f7d9 to
0fcc5f8
Compare
# for free
to join this conversation on GitHub.
Already have an account?
# to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Closes #5496
Adds a plain error template for
DocumentationRenderer.Previously we've not had to switch template for the error case, since both cases are presented the same. With the interactive docs we need to switch to a different template. (We do this by checking whether we have a
coreapi.Document, as expected, or not.)I've not added any styling here. For the 90% case seeing this template is a configuration error, so I've added DEBUG-only notes for explaining that.
Those that need a better template can easily override in their own projects.
We can happily take PRs improving this template, but I'd rather leave that for community input at this point.