-
-
Notifications
You must be signed in to change notification settings - Fork 5.5k
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.
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
doc: remove changing "Stacktrace" in errors by [...] #22075
Conversation
xref comments in #20202 when I tried to sneak this in 😛 |
-1, I think showing some of the stacktrace is useful to show where the error and corresponding code happens. If the concern is just avoiding having to update line numbers, would be better to adjust Documenter to add a permissive mode that ignores line number differences on master. |
+1 It is a lot of extra noise when reading the docs. Anyone who is interested in the stack trace can run the code in the repl. |
not easily, if you're reading the documentation from somewhere that doesn't have julia installed, or mobile. |
Yeah, those are the cases where this is likely more annoying than helpful since it is a real pain to navigate through the stacktrace on such a device. |
it looks fine to me, scrolling works normally, it's useful information to show and doesn't take a whole lot of space if you're selective about showing only the top few most relevant frames. also makes the output more representative of what you'd get from actually running the code - in a perfect world our docs would be live runnable snippets. |
@fredrikekre oups sorry, I didn't even had the idea about searching for this topic as I thought it would be uncontroversial (in particular as it is suggested in Documenter). |
Many of these have always been shown for as long as there have been doctests here, #4897
It's used in the same way as the output from example code is used, an illustrative part of what the code will do when run. |
I think we should do this. In e.g. https://docs.python.org/2/library/doctest.html#what-about-exceptions they say:
So we can keep it when there is a point to it. But having it by default is just noise. |
I will rebase this if a decision is made. |
I was almost done with a rebased (actually done from scratch) version so I pushed it. I also added one commit with you as author for the description. #23988 |
Cf. https://juliadocs.github.io/Documenter.jl/latest/man/doctests/.