Links in code reference (and example code) #1498
Description
Most of the Espruino reference page is really bad at linking through to other referenced functions. For example NRF.requestDevice may be mentioned in NRF.findDevices, but it should be a link so it can be clicked.
I recently changed the documentation builder so as long as the actual documentation contains the function/class/event's name inside single backticks, it should get automatically linked.
So, please can you flag up if:
- If you see some bit of documentation that references some other part of the Espruino API that should be linked and isn't
- Some bit of the documentation that should be in monospaced code font and isn't
- If you notice something where an example would be handy, and you have a simple example
Maybe just post up here if you find something? Or you can fix it yourself:
- Click on the
⇒icon to the right of the affected function's heading - It'll take you to where the documentation is in Espruino's code in GitHub
- Make sure you're signed into GitHub and click the edit icon in the top right
- Make the changes to the documentation (After the
/*JSON{ .... }part you can just write code as simple Markdown). Put multiline code the three backticks```, or just reference objects/functions/methods etc inline in a single backtick - Issue a pull request