by the way the issue on github was opened and closed in a few hours, weird, and not polite...
I noticed that and assumed it meant that the required documentation had been added to the reference pages, since the person who closed the issue is in charge of the documentation. I would prefer that people take a few seconds to write a reply when they do that to prevent any confusion. That has been a big frustration to me as a volunteer contributor to open source projects. I submit a pull request, then it gets closed. I have to waste time looking through the commit history to figure out whether:
- My PR was such garbage that they didn't even think it was worth responding to before they rejected it.
- The maintainer is clueless about how GitHub works and reproduced my work, rather than just clicking the "Merge" button. In this case, I find they screwed it up about half the time.
- A repository maintainer accidentally closed the PR.
Unfortunately, there isn't public version control for the documentation content so I can't check what changed. I notice on this page:
A byte array containing the MAC address of the router the WiFi shield is currently connected to or the MAC address of a network that was scanned. The first array index contains the last byte of the MAC address.
That last sentence seems to provide the necessary documentation.
The macAddress() reference page does not contain similar text. I do notice that both pages have example code that demonstrates the situation. I don't know whether that code is new, or if it was always there. Maybe you remember how the pages were before? It's possible that the person updating the documentation thought the issue was only about BSSID(), since that's more prominent in your comment on that issue thread. If there seems to have been no change to the macAddress() reference page, I would recommend that you comment on the issue again to request that it be updated in a similar manner to BSSID.
I already see that the idea of documenting the core is already there
Yeah, that could be really nice to have. It comes up periodically here on the forum where people want to make a custom hardware core and ask where the documentation is at. I point them to the Arduino Hardware Specification page, which is great as a reference, but it doesn't do a good job of walking someone through the process of creating a core.