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

[Doc] Species doc attribute #16

Open
gabrielasd opened this issue Feb 2, 2024 · 0 comments
Open

[Doc] Species doc attribute #16

gabrielasd opened this issue Feb 2, 2024 · 0 comments
Assignees
Labels
enhancement New feature or request

Comments

@gabrielasd
Copy link
Collaborator

Currently the doc attribute of the Species class holds the documentation of the loaded dataset. It gets assigned by calling the function get_docstring

1- The docstrings are mere place holders for now, and its likely that the get_docstring function itself needs revision. Maybe instead of typing the information directly in the body of the function we should have it in a separate file(s)?

2- It could also be nice to add some functionality that appended a table with the actual properties available for the loaded specie.

The function get_docstring should grab the variable atomdb.{dataset}.DOCSTRING and return that. This allows us to keep all the information about each dataset in the same file, {dataset}/__init__.py.

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

No branches or pull requests

2 participants