You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
While there is sphinx documentation for the project, along with a quickstarter guide, the project is missing documentation/references for a few key areas.
The quickstarter guide is outdated. While it was originally correct, Wrapper has been renamed to Client, meaning that the example code will not work.
There is also no reference to AsyncClient within the README. While AsyncClient has no major usage differences to Client, the guide would benefit from including both to ensure that users are aware of both of them.
There are also no guides for contributing to the project. While the project does not have a large amount of requirements or a large amount of setup to begin development, it would make development easier to set a standard for issue format, linting and coding/documentation styling.
To resolve this, I would like to establish contribution standards, including linting, an issue template and coding/documentation stylings. I would also like to update the quickstarter guide to target the current version of the project.
The text was updated successfully, but these errors were encountered:
While there is sphinx documentation for the project, along with a quickstarter guide, the project is missing documentation/references for a few key areas.
The quickstarter guide is outdated. While it was originally correct,
Wrapper
has been renamed toClient
, meaning that the example code will not work.There is also no reference to
AsyncClient
within the README. WhileAsyncClient
has no major usage differences toClient
, the guide would benefit from including both to ensure that users are aware of both of them.There are also no guides for contributing to the project. While the project does not have a large amount of requirements or a large amount of setup to begin development, it would make development easier to set a standard for issue format, linting and coding/documentation styling.
To resolve this, I would like to establish contribution standards, including linting, an issue template and coding/documentation stylings. I would also like to update the quickstarter guide to target the current version of the project.
The text was updated successfully, but these errors were encountered: