simpleart / pymath-interval Goto Github PK

The README as it stands of now could use a bit of work with details and instructions on the usage of the library and other useful information in general.

Have a github action run the unittests for every push made to master branch, and for every Pull Request opened.

Write user documentation:

a. Create module doc-strings:

1. Replicate README.md for the package doc-string.
2. Rewrite markdown code blocks as doc-tests.
3. Give an overview of what each module is doing.
4. Provide examples if appropriate.

b. Create function doc-strings:

1. Briefly describe what each function/method is doing.
2. Briefly describe the parameters and returns/yields.
3. Provide examples.

c. Create class doc-strings:

1. Briefly describe what the Interval class is for.
2. Briefly describe what the interval sentinel is for.
3. Document the interval(x) constructor.
4. Document the interval[x:y] constructor.
5. Document the attributes.
6. Briefly describe the properties.
7. Provide examples (especially for dunder methods).

The code as it stands today does not any test coverage.

Add unit tests so this is no longer true.

Create tests:
a. Test methods in the Interval class.
b. Test branches (make sure to check all cases).
c. Test correctness using decimal.Decimal.

Add a github action that performs a flake8 python linting test on every push made to master branch as well as every PR opened.

Write developer comments:
a. Explain weird floating-point and bit manipulations.
b. Explain math logic.

Even better if the code can be refactored to be self-explanatory thereby eliminating the need for dev comments.