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

Refactor into modules and improve documentation #6

Open
daemontus opened this issue Oct 16, 2023 · 0 comments
Open

Refactor into modules and improve documentation #6

daemontus opened this issue Oct 16, 2023 · 0 comments

Comments

@daemontus
Copy link
Member

daemontus commented Oct 16, 2023

Right now, we only have one big module where everything resides. We should split this up into sub-modules. These sub-modules can loosely follow the structure of sections/sub-sections in the original SBML specification.

In terms of documentation, ideally, we should have a reference to the core SBML specification in the documentation for each SBML wrapper struct. We could even copy the relevant content of the specification in each docstring. Furthermore, it is possible to include images in the generated documentation. Maybe we could include the class diagrams from the official specification document where applicable. This would be really nice.

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

No branches or pull requests

1 participant