python: update README #415
Conversation
python/README.md
Outdated
|
|
||
| # connect to a non-default port on the local network | ||
| aica = AICA(port=55000) | ||
| aica = AICA(url='http://localhost:55005/api') |
There was a problem hiding this comment.
Well if anything, this constructor should also do the api_key= which has become mandatory in v4 of the api client.
There was a problem hiding this comment.
Then we should add it in every AICA() call from there to the top? If yes, shouldn't we just move the Authentication section on top, even maybe before Basic Usage?
There was a problem hiding this comment.
Yes that might be a good thing to do now that it has become required. We could then mention that this was not always the case instead of the other way around
python/README.md
Outdated
|
|
||
| # connect to a non-default port on the local network | ||
| aica = AICA(url='http://localhost:55005/api') | ||
| aica = AICA(url='http://localhost:55005/api', api_key=AICA_API_KEY) |
There was a problem hiding this comment.
Can you switch the arguments around here please, even though not striclty required
domire8
left a comment
domire8
left a comment
There was a problem hiding this comment.
Works for me but happy for at least one other review 👍 thanks
Description
Small fixes in the README that I noticed. More of a draft, if you notice there is something else to fix, we can probably squeeze it here.
Review guidelines
Estimated Time of Review: x5minutes
Checklist before merging: