docs: convert Backtracing.rst to Markdown
#64628
Open
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
MaxDesiatov
force-pushed
the
maxd/backtracing-markdown
branch
from
22c68a8 to
50c7eb8
Compare
Resolves partially #49997.
MaxDesiatov
force-pushed
the
maxd/backtracing-markdown
branch
from
50c7eb8 to
fbbb560
Compare
AnthonyLatsis
approved these changes
Mar 29, 2023
| frames at the bottom of the stack where the actual fault occurred. | ||
|
|
||
| 1. There are `limit` or fewer frames. In this case we will display all | ||
| the frames in the backtrace. Note that this \_[includes]() the case |
There was a problem hiding this comment.
I think "includes" was meant to be in italic here.
Comment on lines
+72
to
+82
| 1. There are `limit` or fewer frames. In this case we will display all | ||
| the frames in the backtrace. Note that this \_[includes]() the case | ||
| where there are exactly `limit` frames. | ||
| 2. There are more than `limit` frames. | ||
| 1. `top` is `0`. We will display the first `limit - 1` frames | ||
| followed by `...` to indicate that more frames exist. | ||
| 2. `top` is less than `limit - 1`. We will display | ||
| `limit - 1 - top` frames from the bottom of the stack, then a | ||
| `...`, then `top` frames from the top of the stack. | ||
| 3. `top` is greater or equal to `limit - 1`. We will display `...`, | ||
| followed by `limit - 1` frames from the top of the stack. |
There was a problem hiding this comment.
How about changing all these bullet introducers to 1. and letting the renderer take care of enumerating them instead?
| should contain a `,`-separated list of `key=value` pairs. Supported keys | ||
| are as follows: | ||
|
|
||
| | Key | Default | Meaning | |
There was a problem hiding this comment.
Would it hurt the rendered result if we shrink the tables horizontally as in the old file to ease reading the raw text?
No problem at all, I still would like to get document author's approval first 🙂 |
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 rendered Markdown document looks identical to the original
.rstdocument, except:Resolves partially #49997.