Wrong examples on i2c documentation

Community Website and Forum
1

Hi,

The slave code seems wrong at the page:

It shows a the slave receiver code instead of the slave sender code, so makes it hard for new learners to understand.

Is this the right place to report it?

best
Hoegge

2

Thanks for reporting this @hoegge!

hoegge:
Is this the right place to report it?

You're always very welcome to begin with the forum when reporting issues like this, in order to get initial feedback from the community. However, the people at Arduino who can fix this specific type of content don't closely monitor the forum, so they won't see your report here. Currently, the best way to report documentation errors is via the Arduino support form:

3

pert:
However, the people at Arduino who can fix this specific type of content don't closely monitor the forum, so they won't see your report here.

What about github? That always used to be the place as far as I know.

Not that anybody there seems to care there except for those that want to make Arduino a better place but can't fix it; reported in Feb 2020

4

You're right that, up until recently, I have always recommended using Arduino's GitHub issue trackers to report problems with Arduino's documentation.

I much prefer the use of GitHub issue trackers to report bugs or make suggestions for improvement. I consider it to be a responsibility of the users of free open source software to make the effort to submit high quality bug reports for any issues we discover. However, when the only way to report a bug is privately, I usually won't bother because I have no way of knowing whether 1000 people before me have reported the same bug and I'm only wasting my time and the time of the people responsible for processing the incoming reports. On a public bug tracker, I can search to see whether the issue was already reported, add additional information to that report if needed, and track the progress of fixing the issue.

However, as you noted, the evidence is that using GitHub to report issues with Arduino's documentation is not working well. For this reason, I'm experimenting with this new approach of recommending people to report documentation via the support form. When you do that, it generates a ticket in Arduino's private support system, which can then be used to track the issue.

5

Does one get a ticket number emailed back when you support? So one can follow up?

Let's see what happens

[question type] Technical support
[/question type]
[subject] Please fix issue with MasterReader tutorial
[/subject]
[message] See issue https://github.com/arduino/Arduino/issues/9740 on github.

Thanks in advance, sterretje
[/message]
6

Yes, whenever you reply it goes on the same ticket so you can provide follow ups or respond to requests for more information from the support staff.

Thanks for submitting the report!

7

Got a reply with a link to the correct code

Hi,

Thank you for the update.

We are aware of it and we are working on it to make the necessary corrections. I will also share the link to the correct sketch below.

https://github.com/arduino/ArduinoCore-avr/blob/master/libraries/Wire/examples/slave_sender/slave_sender.ino

Reported as well :wink:

Have a great day.

best regards,

somebody
Arduino Support Team

It now also shows in https://www.arduino.cc/en/Tutorial/MasterReader (though not the same code as in the above github link, different slave address) and reader and slave don't match regarding I2C address.