Skip to content

Conversation

@rsora
Copy link
Contributor

@rsora rsora commented Oct 16, 2018

Fixes documentation links as per #3 :

  • removed in README.adoc
  • Updated to repo link in library.properties file

Copy link
Contributor

@sandeepmistry sandeepmistry left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Resolves #3.

This was the solution discussed with @SimonePDA.

@q2dg
Copy link

q2dg commented Oct 16, 2018

But this "solution" simply consists in removing the link to the (inexistent) reference. But reference itself doesn't exists yet!

@SimonePDA
Copy link

Dear @q2dg we have decided that libraries that are helpers or internal will not be documented on the standard reference pages (this is why the link was removed) to keep the users focused on what matters and to avoid the dispersion of our resources.
People interested in such internal information can find it inside the library files themselves as we still document the code with all the relevant information and that will be the reference for such kind of libraries.
We have made this choice to allow us to produce the reference documentation online for the fast growing number of libraries that are needed to use the new boards and shields.
If you need information on a library as this one, you are capable of getting it from the comments in the code.
Thank you for your understanding

Simone

@bvernham
Copy link

bvernham commented May 3, 2022

When is the code going to be documented?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

5 participants