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

Document builtin storage plugins #642

Closed
jesper-friis opened this issue Sep 12, 2023 · 0 comments · Fixed by #949
Closed

Document builtin storage plugins #642

jesper-friis opened this issue Sep 12, 2023 · 0 comments · Fixed by #949

Comments

@jesper-friis
Copy link
Collaborator

Add a page in the users guide about provided storage plugins.

It should be possible to generates this page based on the documentation of the plugins as shown in test_storage_plugins.py.

Ideally the we should also allow extraction of documentation from C. Documentation of options should be possible to automatically extract from the option list.

jesper-friis added a commit that referenced this issue Sep 21, 2023
# Description
Fixed iteration over storage plugins. One use case is automatic
generation of documentation of storage plugins (see issue #642).

Quite many changes, but the most interesting change is [this
line](https://github.com/SINTEF/dlite/pull/643/files#diff-afaeddf3751c622eaae4bed224fa4dec3b7db2c6d95d86b0a837a1b3eaeaef17R220).

Additional fixes:
- Got rid of occasional segfaults during shutdown of DLite.
- Updated tests

## Type of change
- [x] Bug fix & code cleanup
- [ ] New feature
- [ ] Documentation update
- [x] Test update

## Checklist for the reviewer
This checklist should be used as a help for the reviewer.

- [ ] Is the change limited to one issue?
- [ ] Does this PR close the issue?
- [ ] Is the code easy to read and understand?
- [ ] Do all new feature have an accompanying new test?
- [ ] Has the documentation been updated as necessary?
@jesper-friis jesper-friis linked a pull request Sep 12, 2024 that will close this issue
15 tasks
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 a pull request may close this issue.

1 participant