Feature/docs

[pastorsj]

PR Checklist

Please check if your PR fulfills the following requirements:

• [x] Tests for the changes have been added (for bug fixes / features)
• [x] Docs have been added / updated (for bug fixes / features)

PR Type

What kind of change does this PR introduce?

[ ] Bugfix
[ ] Feature
[ ] Code style update (formatting, local variables)
[ ] Refactoring (no functional changes, no api changes)
[ ] Build related changes
[ ] CI related changes
[x] Documentation content changes
[ ] Other... Please describe:

What is the current behavior?

Issue Number: #29

What is the new behavior?

I have now completely updated the api documentation

Does this PR introduce a breaking change?

[ ] Yes
[x] No

Other information

[pastorsj]

LGTM

[coveralls]

Coverage remained the same at 83.117% when pulling 4f3101aceaefb2a5bc65e6a1d3ceef6e5c71f436 on feature/docs into 6e32b619ef1cf37033241553779c50c3abbf2b0d on master.

[coveralls]

Coverage remained the same at 83.117% when pulling 4f3101aceaefb2a5bc65e6a1d3ceef6e5c71f436 on feature/docs into 6e32b619ef1cf37033241553779c50c3abbf2b0d on master.