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

Results docs cleanup #479

Merged
merged 3 commits into from
Aug 29, 2024

Conversation

stevebachmeier
Copy link
Contributor

Results docs cleanup

Description

  • Category: documentation
  • JIRA issue: na

Changes and notes

This does three primary things

  1. Adds results module-level docstrings to improve sphinx rendering
  2. Strengthen SimpleCause docstrings
  3. Rename the SimpleCause class method

Testing

tests pass and docs build

Disability Observer
===================
====================
Disability Observers
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The risk docstring was plural so I wanted to be consistent. I prefer plural to leave room for future observers in each module

src/vivarium_public_health/results/observer.py Outdated Show resolved Hide resolved
@stevebachmeier stevebachmeier merged commit 2574cd2 into main Aug 29, 2024
6 checks passed
@stevebachmeier stevebachmeier deleted the feature/sbachmei/add-missing-module-docstrings branch August 29, 2024 17:09
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

Successfully merging this pull request may close these issues.

3 participants