HttpAdapter docs #142
HttpAdapter docs #142
Conversation
todofixthis
left a comment
todofixthis
left a comment
There was a problem hiding this comment.
Hey Marius! Thanks for working on this!
I've requested a few changes; when you have a chance, could you have a look?
README.rst
Outdated
| PyOTA's documentation is available on `ReadTheDocs`_. | ||
|
|
||
| If you are :ref:`installing from source <readme-installing-from-source>`, you | ||
| If you are [installing from source](#installing-from-source), you |
There was a problem hiding this comment.
The previous syntax is actually correct for .rst files. I'll file a request with GitHub support to figure out why it's not rendering correctly.
There was a problem hiding this comment.
Hey Marius. I heard back from GitHub support.
Turns out that :ref: is not actually part of the reStructuredText spec; it's a custom feature provided by Sphinx.
I made the following changes:
- Removed the link.
- Added a metadata check to
.travis.yml(which caught the:ref:right awy!).
Thanks for drawing attention to this issue!
docs/adapters.rst
Outdated
| # Use HTTPS with basic authentication and 60 seconds timeout: | ||
| api = Iota('https://USERNAME:MYIRIPASSWORD@service.iotasupport.com:14265', | ||
| timeout=60) |
There was a problem hiding this comment.
❔ I'm not sure that this works — I believe the timeout argument only works with an HttpAdapter instance.
There was a problem hiding this comment.
Yes, that was a bit sloppy, copy-paste...
| api = Iota( | ||
| HttpAdapter( | ||
| 'https://USERNAME:MYIRIPASSWORD@service.iotasupport.com:14265', | ||
| timeout=60)) |
todofixthis
left a comment
todofixthis
left a comment
There was a problem hiding this comment.
Looks good! Thanks Marius!!
…d/docs HttpAdapter docs
2 participants
Sane version of #137 addressing issue #129