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 README and home page of the docs #423

Merged
merged 3 commits into from
Oct 21, 2024
Merged

Conversation

drbenvincent
Copy link
Collaborator

@drbenvincent drbenvincent commented Oct 11, 2024

Partially addresses #422

For both the GitHub README, and the docs home page this PR:

  • Removes the images from the Features section. Also removes their source files, and the notebook that generated them.
  • Replaces that section with a table of the various methods / quasi-experimental designs.

📚 Documentation preview 📚: https://causalpy--423.org.readthedocs.build/en/423/

@drbenvincent drbenvincent marked this pull request as draft October 11, 2024 09:25
Copy link

Check out this pull request on  ReviewNB

See visual diffs & provide feedback on Jupyter Notebooks.


Powered by ReviewNB

@drbenvincent drbenvincent marked this pull request as ready for review October 11, 2024 09:38
Copy link

codecov bot commented Oct 11, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 94.40%. Comparing base (d31a033) to head (f479100).
Report is 4 commits behind head on main.

Additional details and impacted files
@@           Coverage Diff           @@
##             main     #423   +/-   ##
=======================================
  Coverage   94.40%   94.40%           
=======================================
  Files          31       31           
  Lines        1985     1985           
=======================================
  Hits         1874     1874           
  Misses        111      111           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

Copy link
Collaborator

@juanitorduz juanitorduz left a comment

Choose a reason for hiding this comment

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

Regarding the PR itself it looks good.

Still, personally, I think I like the plots more, but this is just my personal opinion. The table is also good :)

@drbenvincent
Copy link
Collaborator Author

I know what you mean, but it started to feel cluttered.

@drbenvincent drbenvincent merged commit e183868 into main Oct 21, 2024
8 checks passed
@drbenvincent drbenvincent deleted the home-page-update branch October 21, 2024 12:46
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.

2 participants