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

Documentation: API functions #1991

Open
jkiviluo opened this issue Feb 17, 2023 · 1 comment
Open

Documentation: API functions #1991

jkiviluo opened this issue Feb 17, 2023 · 1 comment
Labels
Milestone

Comments

@jkiviluo
Copy link
Member

In Mopo kick-off it was brought up that there should be better API function documentation. We have the documentation that comes from code comments (https://spine-toolbox.readthedocs.io/en/latest/autoapi/index.html), but there should also be a higher level description to make the API more understandable. Probably makes sense to do this for the new API only.

@jkiviluo jkiviluo added this to the V0.8 milestone Feb 17, 2023
@jkiviluo jkiviluo added the Docs label Feb 17, 2023
@soininen
Copy link
Contributor

I think this is most critical for spinedb_api for development of tools/scripts that use Spine databases. Toolbox API is not that interesting unless you're actually developing the Toolbox itself.

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

No branches or pull requests

2 participants