Skip to content
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

Closed
wants to merge 2 commits into from

Conversation

rfourquet
Copy link
Member

@fredrikekre
Copy link
Member

xref comments in #20202 when I tried to sneak this in 😛

@tkelman
Copy link
Contributor

tkelman commented May 26, 2017

-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.

@KristofferC
Copy link
Member

+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.

@tkelman
Copy link
Contributor

tkelman commented May 26, 2017

not easily, if you're reading the documentation from somewhere that doesn't have julia installed, or mobile.

@KristofferC
Copy link
Member

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.

@tkelman
Copy link
Contributor

tkelman commented May 26, 2017

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.

image

@KristofferC
Copy link
Member

I meant to go through the source code for where the stacktrace points to.

it's useful information to show

image

@rfourquet
Copy link
Member Author

@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).
I don't have a strong opinion myself, but would be on the side to remove it, maybe while keeping the line containing "Stackstrace:" before the "[...]" to make explicit what output is suppressed. Why not keeping one place or two in the manual with the full stacktrace, as an exemple, but I would believe that otherwise the information is not used by people while reading the manual.
Anyway, whatever decision is taken, it's probably worth it to document it once it's taken, so I will update this PR then, hoping some more people will give their opinion.

@tkelman
Copy link
Contributor

tkelman commented May 27, 2017

Many of these have always been shown for as long as there have been doctests here, #4897

the information is not used by people while reading the manual.

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.

@rfourquet rfourquet added the docs This change adds or pertains to documentation label Jun 3, 2017
@KristofferC
Copy link
Member

I think we should do this. In e.g. https://docs.python.org/2/library/doctest.html#what-about-exceptions they say:

Best practice is to omit the traceback stack, unless it adds significant documentation value to the example. So the last example is probably better as:

So we can keep it when there is a point to it. But having it by default is just noise.

@rfourquet
Copy link
Member Author

I will rebase this if a decision is made.

@KristofferC
Copy link
Member

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

@rfourquet rfourquet closed this Oct 4, 2017
@DilumAluthge DilumAluthge deleted the rf/doc-remove-stacktraces branch March 25, 2021 22:09
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs This change adds or pertains to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants