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

Tidy docs #175

Open
wants to merge 12 commits into
base: main
Choose a base branch
from
Open

Tidy docs #175

wants to merge 12 commits into from

Conversation

zorian15
Copy link
Collaborator

@zorian15 zorian15 commented Jun 7, 2022

Description

A lot of TLC for the docs. Mainly addressing lingering TODOs. A summary of the changes include:

  • Schematic images for torchdms models
  • A notebook with math write ups for torchdms models
  • Some tweaks to the CLI tutorials

No direct issue for these things, but should be able to close a lot of the old issues -- Closes #160 #161 and #131

Tests

The build okay locally 😅

Checklist:

  • The code uses informative and accurate variable and function names
  • The functionality is factored out into functions and methods with logical interfaces
  • Comments are up to date, document intent, and there are no commented-out code blocks
  • Commenting and/or documentation is sufficient for others to be able to understand intent and implementation
  • TODOs have been eliminated from the code
  • The corresponding issue number (e.g. #278) has been searched for in the code to find relevant notes
  • Documentation has been redeployed

@zorian15 zorian15 added the documentation Improvements or additions to documentation label Jun 7, 2022
@zorian15 zorian15 requested a review from jgallowa07 June 7, 2022 23:58
@zorian15 zorian15 assigned zorian15 and unassigned zorian15 Jun 7, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Docstrings for utils
1 participant