search

dgasmith / opt_einsum

⚡️Optimizing einsum functions in NumPy, Tensorflow, Dask, and more with contraction order optimization.
https://dgasmith.github.io/opt_einsum/
MIT License
848 stars 68 forks source link

Add flake8 and spell check, whitelist dictionary, docstrings #155

Closed asears closed 3 years ago

asears commented 3 years ago

Description

In learning more about opt_einsum and its codebase and dependencies, would like to take some time improve on the documentation by implementing flake8-spellcheck and fixing some minor spelling and markdown format issues.

Some items addressed in PR:

  1. Add flake8 and spell check packages to conda full test.
  2. Add a whitelist dictionary
  3. Fix docstring spelling SC100 issues
  4. Fix markdown formatting

Todos

Add Terminology / Glossary to documentation.

Questions

  1. Does the change to Conda environment files break any CI builds?
  2. Does the change to readme file break any Sphinx documentation formatting?

Status

codecov[bot] commented 3 years ago

Codecov Report

Merging #155 (82f430d) into master (32fa384) will not change coverage. The diff coverage is 100.00%.