Skip to content

Conversation

@per1234
Copy link
Contributor

@per1234 per1234 commented Jul 21, 2022

Arduino IDE 2.x has two controls related to the integrated debugger:

  • The Toolbar button, which is used to initialize the debugger
  • The Activity Bar button, which is used to open and close the "Debug" view in the Side Panel

These two things have completely distinct purposes and can not be used interchangeably. Yet they look very similar. Feedback indicates that this complex interface causes confusion for users, and that such confusion will result in the inability to use the debugger, so it is important for the documentation to clearly differentiate between the two.

The debugger tutorial contains separate introductory text and screenshots for each of the buttons. Previously, the content for these two distinct things was ordered like so:

  • Introductory text for Activity Bar button
  • Introductory text for Toolbar button
  • Screenshot for Activity Bar button
  • More text related to Toolbar button
  • Screenshot for Toolbar button

This order could lead the reader to think the Activity Bar button screenshot was showing the control referenced by the Toolbar button introductory text, since the screenshot came after that introductory text.

What This PR Changes

Use a more logical and clear order:

  • Introductory text for Activity Bar button
  • Screenshot for Activity Bar button
  • Introductory text for Toolbar button
  • More text related to Toolbar button
  • Screenshot for Toolbar button

Contribution Guidelines

@per1234 per1234 added enhancement New feature or request arduino Bugs and fixes added by the Arduino Team labels Jul 21, 2022
@jhansson-ard jhansson-ard requested a review from karlsoderby July 21, 2022 07:04
…tion

Arduino IDE 2.x has two controls related to the integrated debugger:

- The Toolbar button, which is used to initialize the debugger
- The Activity Bar button, which is used to open and close the "Debug" view in the Side Panel

These two things have completely distinct purposes and can not be used interchangeably. Yet they look very similar. Feedback indicates that this complex interface causes confusion for users, and that such confusion will result in the inability to use the debugger, so it is important for the documentation to clearly differentiate between the two.

The debugger tutorial contains separate introductory text and screenshots for each of the buttons. Previously, the content for these two distinct things was ordered like so:

- Introductory text for Activity Bar button
- Introductory text for Toolbar button
- Screenshot for Activity Bar button
- More text related to Toolbar button
- Screenshot for Toolbar button

This order could lead the reader to think the Activity Bar button screenshot was showing the control referenced by the Toolbar button introductory text, since the screenshot came after that introductory text.

The order is hereby changed to be more logical and clear:

- Introductory text for Activity Bar button
- Screenshot for Activity Bar button
- Introductory text for Toolbar button
- More text related to Toolbar button
- Screenshot for Toolbar button
Copy link
Contributor

@karlsoderby karlsoderby left a comment

Choose a reason for hiding this comment

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

LGTM!

@per1234 per1234 merged commit 118a768 into arduino:main Jul 27, 2022
@per1234 per1234 deleted the debug-control-screenshot-position branch July 27, 2022 11:30
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

arduino Bugs and fixes added by the Arduino Team enhancement New feature or request

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants