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.

Sign up for GitHub

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

Jump to bottom

Add sphinx documentation #10

Open
oerc0122 opened this issue Jul 21, 2023 · 0 comments
Open

Add sphinx documentation #10

oerc0122 opened this issue Jul 21, 2023 · 0 comments

Comments

@oerc0122
Copy link
Owner

No description provided.

@oerc0122 oerc0122 mentioned this issue Jul 28, 2024
Merged
oerc0122 added a commit that referenced this issue Sep 11, 2024
@oerc0122
Docstrings (#146)
f83e671 
Extensive rework of documentation (still ongoing):
- Adds numpy docstrings to all functions.
- Adds TypedDict return docs to all file-parsers (except complex ones
such as cell/param/castep).
- Makes several file-parsers slightly more consistent in handling of
params.
- Add docstring tests to relevant utility functions.

Fixes #132 
Address #10
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@oerc0122