PR includes a stable version of the bitfinex-api-py's documentation (v3-beta).
PR also adds a lot of new content to the documentation and improves readability.
README.md now contains everything users may need to start using v3.0.0b1.
Motivation and Context
Documentation was incomplete and not stable enough for release.
bitinex-api-py's documentation is now ready to help users take their first steps with v3.0.0b1.
Related Issue
PR fixes the following issue: -
Type of change
[ ] Bug fix (non-breaking change which fixes an issue);
[X] New feature (non-breaking change which adds functionality);
[ ] Breaking change (fix or feature that would cause existing functionality to not work as expected);
[X] This change requires a documentation update;
Checklist:
[ ] My code follows the style guidelines of this project;
[ ] I have performed a self-review of my code;
[ ] I have commented my code, particularly in hard-to-understand areas;
[X] I have made corresponding changes to the documentation;
[X] My changes generate no new warnings;
[ ] I have added tests that prove my fix is effective or that my feature works;
[X] New and existing unit tests pass locally with my changes;
[X] Mypy returns no errors or warnings when run on the root package;
[X] Pylint returns a score of 10.00/10.00 when run on the root package;
[ ] I have updated the library version and updated the CHANGELOG;
Description
PR includes a stable version of the
bitfinex-api-py
's documentation (v3-beta). PR also adds a lot of new content to the documentation and improves readability. README.md now contains everything users may need to start using v3.0.0b1.Motivation and Context
Documentation was incomplete and not stable enough for release.
bitinex-api-py
's documentation is now ready to help users take their first steps with v3.0.0b1.Related Issue
PR fixes the following issue: -
Type of change
Checklist: