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

Refguide: refresh content of the debugging.adoc section #2785

Closed
7 of 8 tasks
simonbasle opened this issue Sep 23, 2021 · 2 comments
Closed
7 of 8 tasks

Refguide: refresh content of the debugging.adoc section #2785

simonbasle opened this issue Sep 23, 2021 · 2 comments
Assignees
Labels
type/documentation A documentation update
Milestone

Comments

@simonbasle
Copy link
Member

simonbasle commented Sep 23, 2021

In debugging.adoc there are a number of outdated representation of tracebacks.
Notably:

  • In "Reading a Stack Trace in Debug Mode", the fact that now the original stack trace is moved to the end is not reflected
  • The term traceback should probably only be used when talking about assembly trace pointing to the original operator use, not the "Error has been observed by the following operator(s)" (fix throughout the debugging section) Let's make sure traceback more clearly refers to whatever additional information reactor adds.
  • "Error has been observed by the following operator(s)" is now "Error has been observed at the following site(s)"
  • in "the checkpoint alternative": checkpoint rendering doesn't state "light" anymore
  • Rendering of named checkpoints with forced stacktrace don't show the name #2819
  • In that same section we should probably explain what to expect when having both Hooks.onOperatorDebug() mixed with light checkpoint(String)
  • codebase still contains two wordings: traceback (most used 👍) and backtrace (least used 👎) => harmonize on traceback
  • ...
@simonbasle simonbasle added the type/documentation A documentation update label Sep 23, 2021
@simonbasle simonbasle added this to the 3.3.x Backlog milestone Sep 23, 2021
@simonbasle
Copy link
Member Author

note the situation has been improved in 3.4.x by #2780 and #2814

@simonbasle
Copy link
Member Author

opening a separate issue for the rendering of checkpoints in default/light/heavy modes: #2819 fixing in #2820

@simonbasle simonbasle self-assigned this Oct 20, 2021
@simonbasle simonbasle modified the milestones: 3.4.x Backlog, 3.4.13 Dec 3, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
type/documentation A documentation update
Projects
None yet
Development

No branches or pull requests

1 participant