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

Feature/math #2

Open
wants to merge 7 commits into
base: master
Choose a base branch
from
Open

Feature/math #2

wants to merge 7 commits into from

Conversation

ken-morel
Copy link

@ken-morel ken-morel commented Sep 23, 2024

Hello, this is a sum of changes and improvements regarding documentation and usage.

Thanks!

@ken-morel
Copy link
Author

Hello, like your library, it provide many base core functionalities for displaying maths, but I will outline some issues:

  • It may lack of proper documentation: Learning how to use it required me to read it's source, which many users may not afford to.
  • It may be hard to use: Sometimes it will be hard and timetaking to create and assemble such primitives one by one from code

This brings in more documentation using docstrings and handsdown generated markdown documentation and also adds a helper module math which provide simpler interface to the packages core

ken-morel

This comment was marked as off-topic.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant