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

Document bool type in reference #6657

Closed
per1234 opened this issue Aug 26, 2017 · 4 comments
Closed

Document bool type in reference #6657

per1234 opened this issue Aug 26, 2017 · 4 comments
Assignees
Labels
Component: Documentation Related to Arduino's documentation content feature request A request to make an enhancement (not a bug fix) in progress Work on this item is in progress

Comments

@per1234
Copy link
Collaborator

per1234 commented Aug 26, 2017

As discussed in #4673, it is desirable to encourage the use of the standard bool type rather than Arduino's boolean alias. The first step is to document the bool type in the Arduino reference.

  1. Create a bool reference page. Please don't capitalize bool in the URL, that was a terrible idea.
  2. Copy the documentation from the boolean reference page to the bool reference page, changing all references to the boolean type to bool.
  3. Replace the documentation in the boolean reference page with this:

boolean is a non-standard type alias for bool defined by Arduino. It's recommended to instead use the standard type bool, which is identical.

Once this has been done I will submit pull requests to remove the use of boolean from all official Arduino code and request updates of any other documentation that uses it.

@per1234 per1234 added Component: Documentation Related to Arduino's documentation content feature request A request to make an enhancement (not a bug fix) labels Aug 26, 2017
@kengdahl kengdahl self-assigned this Dec 27, 2017
@kengdahl kengdahl added the in progress Work on this item is in progress label Dec 27, 2017
@kengdahl
Copy link
Member

kengdahl commented Jan 2, 2018

I will happily implement this as soon as there is a response from someone from Responsible (like @cmaglie) on the subject in #4673.

@per1234
Copy link
Collaborator Author

per1234 commented Jan 2, 2018

Now that the reference-en repository is functional I had planned to submit a pull request to add the requested bool reference page, and also propagate that page out to the reference translation repositories after it was merged. However, it would be nice to get a statement on whether this move to encourage bool over boolean has official approval since otherwise it's unsure if the proposal will actually be able to move forward.

I still maintain my commitment to doing as much of the footwork as is in my power for this project:

  • Submit pull requests for IDE bundled and official library examples that use boolean.
  • Submit pull requests for any reference pages that use boolean
  • Submit issue reports requesting changes to any documentation using boolean that can't be altered via pull requests. I suspect there will not be many required.

@kengdahl
Copy link
Member

kengdahl commented Jan 2, 2018

I have assigned @cmaglie to this issue besides, just to get a go-ahead.

@cmaglie
Copy link
Member

cmaglie commented Jan 5, 2018

@per1234 let's go with your plan.

Let's wait about setting the deprecated flag, will discuss that in #4673
It's ok to change the examples from boolean to bool instead.

This was referenced May 30, 2018
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Component: Documentation Related to Arduino's documentation content feature request A request to make an enhancement (not a bug fix) in progress Work on this item is in progress
Projects
None yet
Development

No branches or pull requests

3 participants