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

Update documentation #59

Closed
jrsmith3 opened this issue Aug 6, 2022 · 4 comments
Closed

Update documentation #59

jrsmith3 opened this issue Aug 6, 2022 · 4 comments
Assignees
Milestone

Comments

@jrsmith3
Copy link
Owner

jrsmith3 commented Aug 6, 2022

Overview

This issue is a placeholder for the time being, but I know that I will need to update the docs once I make all the changes for release 2.0.0.

Related issues

I will merge the PR for #77 into the release 2.0.0 epic branch, merge the epic branch into the branch corresponding to #76, then continue hacking until I'm able to merge #76.

@jrsmith3 jrsmith3 added this to the Release 2.0.0 milestone Aug 6, 2022
@jrsmith3
Copy link
Owner Author

jrsmith3 commented Aug 7, 2022

I am using numpydoc for the docstrings in the codebase and I would like to use Python type hints instead of declaring the types in the docstring itself. Looks like someone has asked for this feature in numpy/numpydoc#196.

@jrsmith3
Copy link
Owner Author

jrsmith3 commented Aug 8, 2022

Someone mentioned the napoleon extension for sphinx that leverages PEP 484 and PEP 526 docstrings. I'll consider using it instead of numpydoc.

@jrsmith3
Copy link
Owner Author

I need to make sure that as part of this PR I mention that the docstrings in this module use the numpy style.

@jrsmith3
Copy link
Owner Author

I am going to need to do some editing to the mathematical parts of the documentation, particularly with method docstrings. I want to avoid repeating myself (repeating lists of symbols, etc.) but I also want the explanations to be clear. For example, at the time of this comment I am giving the integral representation in BEI.upper but not the expression after the integral has been computed. I should consider giving both.

@jrsmith3 jrsmith3 self-assigned this Aug 20, 2022
@jrsmith3 jrsmith3 mentioned this issue Aug 20, 2022
4 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

No branches or pull requests

1 participant