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 Docstrings #6

Open
18 tasks
jrenaud90 opened this issue Jul 11, 2019 · 0 comments
Open
18 tasks

Add Docstrings #6

jrenaud90 opened this issue Jul 11, 2019 · 0 comments
Labels
Beginner Issue is good for newcomers to TidalPy Docs Documentation and/or Doc Strings needed
Milestone
Version 0.3.0

Comments

@jrenaud90
Copy link
Owner

jrenaud90 commented Jul 11, 2019 •
edited
Loading

Please read the style.md before making new doc strings.

Docstrings should be concise

Sub-Packages

  • burnman_interface
  • cooling
  • dynamics
  • integration
  • radiogenics
  • rheology
  • stellar
  • structures
  • tides
  • tools
  • utilities

Other

  • Loose /TidalPy/ Files
  • Cookbooks and Examples
  • Documentation Folder and/or Wiki
    • OOP vs. Functional
    • How-to add new rheologies
    • How-to add new planets
    • How-to Burnman Basics
@jrenaud90 jrenaud90 added the Docs Documentation and/or Doc Strings needed label Jul 11, 2019
@jrenaud90 jrenaud90 added this to the Version 1.0.0 milestone Jul 11, 2019
@jrenaud90 jrenaud90 added the Beginner Issue is good for newcomers to TidalPy label Jul 11, 2019
@jrenaud90 jrenaud90 changed the title Docstring /bm/ package Add Docstrings Jul 11, 2019
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
Beginner Issue is good for newcomers to TidalPy Docs Documentation and/or Doc Strings needed
Projects
None yet
Milestone
Version 0.3.0
Development

No branches or pull requests
1 participant
@jrenaud90