-
Notifications
You must be signed in to change notification settings - Fork 2
Documentation improvements #106
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
Conversation
|
It might be helpful here to build the docs from the branch. There's an action that might do this with very little effort here: |
julianstirling
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I have skimmed this and made a few comments. I find reading RestructuredText very hard. It would be good if we could compile docs with Actions for reading.
rwb27
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I've addressed all of these comments, except the previews of documentation in merge requests. That ought to be possible, but I'll leave it outstanding for now.
|
I'm at a loss as to why the coverage job is failing. It seems to have all the secrets set as per the instructions - I can only guess I might need to re-install it? |
This should be taken care of by reathedocs.io
|
It turns out There's even a handy diff view! |
julianstirling
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I am merging this now. I have skimmed through everything, and there is a lot more information here. I think we really need to use these docs during dev to understand what needs to be clarified.
The pipeline is failing on the coverage checker because of keys. This is because barecheck can't comment because this PR is from your personal account rather than from the LabThings one. The actual coverage change is -0.07%, which is probably because one of the python doc strings is somehow counted as line of code which is not covered.
This adds some higher-level descriptions of concurrency, Blob objects, and "client" code, as well as the beginning of a tutorial. Currently, the tutorial covers installing and running the library, but not how to write a
Thing. Completing the tutorial would be a very good idea.It would be lovely to get some sort of doctest running: even if all it does is check the code doesn't error, it would guard against these docs going stale when the API changes.