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

Docsite and Docstring overhaul #16

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Docsite and Docstring overhaul #16

wants to merge 1 commit into from

Conversation

alecloudenback
Copy link
Member

@alecloudenback alecloudenback commented May 26, 2020 •
edited
Loading

Other Issues/PRs to address before updating Docs

Docsite

  • Index page with intro/overview and basic example
  • API Subpages
    • Interest Rates
    • Single Life
    • Multiple Lives
  • Examples
    • Link to separate repo with notebooks?

Docstrings

  • review for consistency
  • check that API between Single Life and Joint life usage is similar

README

  • Give quick overview and examples in README, but move bulk into docsite

@alecloudenback alecloudenback changed the title initial doc update (get a commit to make a PR for planning) Docsite and Docstring overhaul May 26, 2020
@alecloudenback alecloudenback added this to the v0.6 milestone May 27, 2020
@alecloudenback alecloudenback modified the milestones: v0.6, v0.6.1 Jun 20, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers
No reviews
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
v0.10.0
Development

Successfully merging this pull request may close these issues.
1 participant
@alecloudenback