Skip to content

debugging article ready for review#57

Merged
carimura merged 11 commits into
mainfrom
boyarsky-debugging
Nov 10, 2023
Merged

debugging article ready for review#57
carimura merged 11 commits into
mainfrom
boyarsky-debugging

Conversation

@boyarsky

@boyarsky boyarsky commented Nov 6, 2023

Copy link
Copy Markdown
Collaborator

This is the article for request #43

@oracle-contributor-agreement oracle-contributor-agreement Bot added the OCA Verified All contributors have signed the Oracle Contributor Agreement. label Nov 6, 2023

@wkorando wkorando left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

Love the article Jeanne! It is a great introduction to both why and how to use a debugger. Only noticed a few minor typos and a few formatting changes that need to be made.

Comment thread app/pages/learn/01_tutorial/08_more-resources/02_debugging.md Outdated
Comment thread app/pages/learn/01_tutorial/08_more-resources/02_debugging.md Outdated
Comment thread app/pages/learn/01_tutorial/08_more-resources/02_debugging.md Outdated
Comment thread app/pages/learn/01_tutorial/08_more-resources/02_debugging.md Outdated
Comment thread app/pages/learn/01_tutorial/08_more-resources/02_debugging.md Outdated
Comment thread app/pages/learn/01_tutorial/08_more-resources/02_debugging.md Outdated
Comment thread app/pages/learn/01_tutorial/08_more-resources/02_debugging.md Outdated
Comment thread app/pages/learn/01_tutorial/08_more-resources/02_debugging.md Outdated
Comment thread app/pages/learn/01_tutorial/08_more-resources/02_debugging.md Outdated
Comment thread app/pages/learn/01_tutorial/08_more-resources/02_debugging.md Outdated

@danthe1st danthe1st left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

I really look forward to this article being added. Here are a few things I feel are still missing:

  • I didn't see anything explaining that a breakpoint can be set by the developer (and how to do it). I am not sure whether someone not knowing about debuggers would realize how to do that from reading the article. It might be a good idea to note that breakpoints can (in most IDEs) be set by clicking next to the lines.
  • While you added Evaluation under Advanced Techniques, you don't seem to explain anything related to viewing variables which is (in my opinion) a central part of debugging.
  • Your magic() example shows the discovery of a bug but how do developers know where to place breakpoints? It might be useful to also add a slightly more complicated example showing how a bug can be found.

Disclaimer: I am just an outside developer who wants to use the article for reference when talking to others. I have no authority here (these are just suggestions) and I am not affiliated or associated with Oracle.

Comment thread app/pages/learn/01_tutorial/08_more-resources/02_debugging.md Outdated
Comment thread app/pages/learn/01_tutorial/08_more-resources/02_debugging.md Outdated
Comment thread app/pages/learn/01_tutorial/08_more-resources/02_debugging.md
@boyarsky

boyarsky commented Nov 6, 2023

Copy link
Copy Markdown
Collaborator Author

Replied to all the easy comments :). The ones I didn't reply to are because I didn't have enough time before my 7pm call, not because I disagree. I'll look at those later tonight or tomorrow.

@boyarsky

boyarsky commented Nov 7, 2023

Copy link
Copy Markdown
Collaborator Author

I think I replied to everything now

Comment thread app/pages/learn/01_tutorial/08_more-resources/02_debugging.md Outdated

@wkorando wkorando left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

Just a couple more small changes, but otherwise, it looks good to me!

Comment thread app/pages/learn/01_tutorial/08_more-resources/02_debugging.md Outdated
Comment thread app/pages/learn/01_tutorial/08_more-resources/02_debugging.md Outdated

@danthe1st danthe1st left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

While reading over it, I found two small details that might still be worth looking into.

Comment thread app/pages/learn/01_tutorial/08_more-resources/02_debugging.md Outdated
Comment thread app/pages/learn/01_tutorial/08_more-resources/02_debugging.md

@danthe1st danthe1st left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

As the person suggesting/requesting an article on debugging, I really like how this has turned out.

@carimura

carimura commented Nov 9, 2023

Copy link
Copy Markdown
Contributor

hey @danthe1st @wkorando appears there are two "conversations" that need resolved and it appears ya'll might be on point with them. If you resolve I can get this merged and deployed!

@danthe1st

danthe1st commented Nov 9, 2023

Copy link
Copy Markdown
Contributor

I don't have the permissions to mark conversations as resolved (also not on my own review comments).

However,it seems like all of my comments (unless maybe the links which seems to be fine) have been addressed.

@boyarsky

Copy link
Copy Markdown
Collaborator Author

All resolved. One was open because I made an edit in response to Dan's comment last night so I wanted to give him 24 hours to read what I wrote. (Thanks for the confirmation Dan.) The other I had already addressed but miss the resolve button.

@carimura

Copy link
Copy Markdown
Contributor

Excellent thank you @boyarsky for the great article and @danthe1st @wkorando for the review! I'll get this deployed soon!

@carimura
carimura merged commit bf38602 into main Nov 10, 2023
@boyarsky
boyarsky deleted the boyarsky-debugging branch November 14, 2023 01:36
@carimura

Copy link
Copy Markdown
Contributor

This has been merged to prod and deployed. Thanks again!

@carimura carimura mentioned this pull request Jan 23, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

OCA Verified All contributors have signed the Oracle Contributor Agreement.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants