ryantwt07 / extended-math Goto Github PK

Is your feature request related to a problem? Please describe.

Some parts of the documentation are not accurate or specific enough.

Describe the solution you'd like

Have multiple documentation files and create a contributing guideline.

Describe alternatives you've considered

Creating a Website for the Documentation.

Additional context

If you want to work on the documentation, run the following code on your terminal.

git fetch origin
git checkout ryantwt07-docs

There is a documentation error in the documentation file. The example code for subtraction is wrong.

On File:

answer = ExtendedMath.subtract(8, 2)
print(answer)
> 4

Correction:

The class function that should be called is .divide and not .subtract.

Corrected:

answer = ExtendedMath.divide(8, 2)
print(answer)
> 4