Fix Available Diagnostics docs table #2265
Merged
Conversation
This file contains 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
|
Let me try to come up with a full solution. I don't want to have lines that super long in the source code. |
|
Documentar has this
So, we should try to make the table scrollable (and fix the multiline comments) |
nefrathenrici
force-pushed
the
ne/diagnostic_comments
branch
from
14f1762 to
62bac4c
Compare
nefrathenrici
force-pushed
the
ne/diagnostic_comments
branch
from
62bac4c to
8d005ab
Compare
|
bors r+ |
|
Build succeeded! The publicly hosted instance of bors-ng is deprecated and will go away soon. If you want to self-host your own instance, instructions are here. If you want to switch to GitHub's built-in merge queue, visit their help page. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in 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.
The available diagnostics page is broken.
Main issue: multi-line strings do not work for the Documenter.jl markdown tables, this turns all comments into single line strings to fix the table.
Second issue: some of the standard names are so long that they effectively hide the description/comments column, since a user would have to scroll to see them.
I think we should switch to PrettyTables, since this provides more control over the formatting available diagnostics.