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

Documentation missing? #94

Open
WestfW opened this issue Jul 9, 2022 · 3 comments
Open

Documentation missing? #94

WestfW opened this issue Jul 9, 2022 · 3 comments

Comments

@WestfW
Copy link

WestfW commented Jul 9, 2022

It says: "Full details on the library functionality can be found on github pages: https://envirodiy.github.io/Arduino-SDI-12/ "
But that loops back to the same https://envirodiy.github.io/Arduino-SDI-12/ page, and it seems to only contain info about history and supported chips and conflicts and limitations, with no information on how to actually USE the library...

I don't see any usage documentation in the source repository either, although there might be some Doxygen scripts that are supposed to extract it.

@SRGDamia1
Copy link
Contributor

Did you look at the examples?

@SRGDamia1
Copy link
Contributor

The https://envirodiy.github.io/Arduino-SDI-12/class_s_d_i12.html page has details about every function of the SDI-12 class, which is the only one meant to be used externally. If you use the "SDI-12" dropdown in the upper right of the documentation, you can jump to any section of that page.

There's also a drop-down in the upper right to help jump to whatever example you might want.

@WestfW
Copy link
Author

WestfW commented Jul 17, 2022

If you use the "SDI-12" dropdown

Ah! There it is! yes, that has all that I was looking for.
I think it's a bit odd that there isn't a link in the text of the page (given the many other links), but I'll concede that it's all there once I notice that there ARE drop-downs at the top of page.

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

No branches or pull requests

2 participants