KEMBAR78
[DOC] Adjust documentation related to backtraces by zverok · Pull Request #12420 · ruby/ruby · GitHub
Skip to content

Conversation

@zverok
Copy link
Contributor

@zverok zverok commented Dec 21, 2024

Mainly handling the changes made around Exception#set_backtrace:

  • error.c:
    • Adjust documentation for #set_backtrace, #backtrace, and #backtrace_locations;
    • Also adjust examples of errors rendering according to the latest changes throughout the file;
  • doc/exceptions.md:
    • Adjust documentation in the Backtraces section;
    • Also adjust examples of rendering throughout the file;
  • eval.c:
    • Adjust Kernel#raise documentation.

PS: Just a reminder that English is not my native language, so any suggestions related to syntax, grammar, and wording are totally OK.

@zverok zverok added the Documentation Improvements to documentation. label Dec 21, 2024
@zverok zverok requested review from byroot and jeremyevans December 21, 2024 17:53
@zverok zverok self-assigned this Dec 21, 2024
@byroot
Copy link
Member

byroot commented Dec 21, 2024

Sorry. I don't have the means to review this now nor any time before release. Use your best judgment

@nobu
Copy link
Member

nobu commented Dec 22, 2024

The changes of examples look fine.
I'm not sure about descriptions.

Copy link
Contributor

@jeremyevans jeremyevans left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Most changes look good. I just have a few recommended wording changes and some typo fixes.

@zverok zverok force-pushed the documentation-backtrace-changes branch from 4674728 to 1e18ff0 Compare December 23, 2024 20:01
@zverok
Copy link
Contributor Author

zverok commented Dec 23, 2024

@jeremyevans Thank you 🙏
Applied all the suggestions, rebased on the latest master, and squashed commits.

@zverok zverok requested a review from jeremyevans December 23, 2024 20:02
@Pricer187

This comment was marked as spam.

@zverok zverok merged commit 58460b4 into ruby:master Dec 24, 2024
41 checks passed
@zverok zverok deleted the documentation-backtrace-changes branch December 24, 2024 18:50
@zverok
Copy link
Contributor Author

zverok commented Dec 24, 2024

(Sorry, have merged without the final approval to make sure the docs would be there after the release.)

@jeremyevans
Copy link
Contributor

That's fine. Sorry that I didn't have time to review yesterday.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Documentation Improvements to documentation.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

5 participants