Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Improve the documentation and README.md #9

Open
1 of 9 tasks
marvinpfoertner opened this issue Dec 22, 2020 · 0 comments
Open
1 of 9 tasks

Improve the documentation and README.md #9

marvinpfoertner opened this issue Dec 22, 2020 · 0 comments
Labels
documentation Improvements or additions to documentation

Comments

@marvinpfoertner
Copy link
Owner

marvinpfoertner commented Dec 22, 2020

  • Write introductory text/project summary
  • Update information in setup.cfg (e.g. keywords, classifiers)
  • Restructure documentation
  • Document how to build without Cython
  • Replace :math:`A'` in docs by :math:`A^+` for updated matrices and :math:`A^-` for downdated matrices
  • Add reference to "scipy.linalg.cholesky" as a source for column-major Cholesky decompositions
  • Make list of exceptions more concrete
  • Move theoretical derivation of update algorithms from Notes section to own documentation page and reference.
  • Add GitHub citation function
@marvinpfoertner marvinpfoertner added the documentation Improvements or additions to documentation label Dec 22, 2020
@marvinpfoertner marvinpfoertner added this to the Initial Release milestone Aug 18, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

1 participant