Skip to content

Conversation

seaxwi
Copy link
Collaborator

@seaxwi seaxwi commented Oct 21, 2022

Updated for 2.0.0

Internal key: HC-1115

@seaxwi seaxwi requested a review from Renat0Ribeir0 October 21, 2022 11:33
@seaxwi seaxwi changed the title Improved and updated for 2.0.0 "Select board and port in Arduino IDE" – improved and updated for 2.0.0 Oct 21, 2022
Copy link
Contributor

@Renat0Ribeir0 Renat0Ribeir0 left a comment

Choose a reason for hiding this comment

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

Added one comment. LGTM otherwise 👍

…no-IDE.md

Co-authored-by: Renat0Ribeir0 <86349945+Renat0Ribeir0@users.noreply.github.com>
Copy link
Collaborator

@per1234 per1234 left a comment

Choose a reason for hiding this comment

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

The label "BOARD CORE" is incorrect on this image:

content/Software Support/Upload/img/board-selector-labels.png

This is the board name, not the core.

@seaxwi
Copy link
Collaborator Author

seaxwi commented Oct 21, 2022

@per1234 I see now that "board core" is inaccurate. I have commited your suggestions and will update the image.

I was trying to clarify that "board" here doesn't refer to a physical device. In the platform specification for boards.txt we have

"This file contains definitions and metadata for the boards supported by the platform"

and

"An extract of the Uno board configuration in boards.txt"

Would you say that "configuration" is a good word to describe what the board selection in Arduino IDE is?

@per1234
Copy link
Collaborator

per1234 commented Oct 21, 2022

Would you say that "configuration" is a good word to describe what the board selection in Arduino IDE is?

I would say that use of that term in a context like the following is reasonable:

Selecting Tools > Board > Arduino AVR Boards > Arduino Uno and the port from Tools > Port in the Arduino IDE menus configures the Arduino IDE to compile and upload the sketch to your Arduino board.

But I do not think it is a good word in a context like this:

Select the board configuration for your Uno from the Tools > Board menu in the Arduino IDE.

"Configuration" adds unnecessary complexity. Although it is important for a boards platform author to understand how a board is defined in boards.txt, it is not at all for the user. All they need and want to know is that they must make the correct board selection from the menu.

I was trying to clarify that "board" here doesn't refer to a physical device.

This is wise. I think the overloading of terminology can be quite confusing to beginners. However, I don't think it is a problem when you are explicitly instructing the user to select something from a menu. In cases where the menu selection is referred to in general, I would use the term "board selection". In these cases, I would reserve the term "board" (or "Arduino board") alone for referring to the hardware.

@seaxwi seaxwi merged commit dbd675b into main Oct 22, 2022
@seaxwi seaxwi deleted the select-board-and-port-ide2 branch October 22, 2022 00:39
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants