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

[skip changelog] Fix incorrect software specificity/non-specificity in documentation #652

Merged
merged 1 commit into from
Apr 17, 2020
Merged

[skip changelog] Fix incorrect software specificity/non-specificity in documentation #652

merged 1 commit into from
Apr 17, 2020

Conversation

per1234
Copy link
Contributor

@per1234 per1234 commented Apr 12, 2020

Please check if the PR fulfills these requirements

  • What kind of change does this PR introduce?
    docs update

  • What is the current behavior?

The documentation imported from the arduino/Arduino wiki was mostly written when Arduino's only official development software was the Arduino IDE. This resulted in many statements that mentioned the Arduino IDE specifically, when they actually apply to other development software as well. Conversely, there were Arduino-IDE specific statements which were not qualified as such.

  • Does this PR introduce a breaking change?

No

  • Other information:

I've used the term "Arduino development software" in documentation that applies to Arduino IDE, Arduino Pro IDE, Arduino Web Editor, and Arduino CLI all.

In the Sketch build process document, it used the term "Arduino environment" three times in the introductory text, which I replaced because I wanted a consistent term throughout the documentation and "Arduino environment" seemed more vague, but if you prefer I could change all instances of "Arduino development software" to "Arduino environment" instead.


I used the term "IDE" or "IDEs" in documentation that applies to Arduino IDE, Arduino Pro IDE and Arduino Web Editor all, but not to Arduino CLI.


I wasn't sure about this line:

The `version` field is validated by both Arduino IDE and [JSemVer](https://github.com/zafarkhaja/jsemver). Here are the rules Arduino IDE follows for parsing versions ([source](https://github.com/arduino/Arduino/blob/master/arduino-core/src/cc/arduino/contributions/VersionHelper.java)):

The version field is validated by both Arduino IDE and JSemVer. Here are the rules Arduino IDE follows for parsing versions (source):

  • Split the version at the - character and continue with the first part.
  • If there are no dots (.), parse version as an integer and form a Version from that integer using Version.forIntegers
  • If there is one dot, split version into two, parse each part as an integer, and form a Version from those integers using Version.forIntegers
  • Otherwise, simply parse version into a Version using Version.valueOf

Can this be changed to:

The version field is validated by the Arduino development software:
...


Fixes #616 (review)

@per1234 per1234 added the topic: documentation Related to documentation for the project label Apr 12, 2020
…n documentation

The documentation imported from the arduino/Arduino wiki was mostly written when Arduino's only official development software was the Arduino IDE. This resulted in many statements that mentioned the Arduino IDE specifically, when they actually apply to other development software as well. Conversely, there were Arduino-IDE specific statements which were not qualified as such.
@rsora rsora merged commit 932f0ed into arduino:master Apr 17, 2020
@per1234 per1234 deleted the development-software-docs branch April 17, 2020 23:39
@per1234 per1234 self-assigned this Nov 23, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
topic: documentation Related to documentation for the project
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants