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

Make README.md and index.qmd more consistent #793

Merged
merged 5 commits into from
Apr 1, 2024

Conversation

julianlheureux
Copy link
Contributor

I have unified the examples presented in both the README section and the main page index of the package. This will assist practitioners by providing cases using both simulated datasets and those incorporated within the package.

Additionally, this feature allows users to run an example without needing to load a dataset themselves.

@codecov-commenter
Copy link

codecov-commenter commented Apr 1, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 90.20%. Comparing base (714ccb7) to head (8087a73).
Report is 1 commits behind head on main.

Additional details and impacted files
@@            Coverage Diff             @@
##             main     #793      +/-   ##
==========================================
+ Coverage   90.14%   90.20%   +0.05%     
==========================================
  Files          46       46              
  Lines        3836     3900      +64     
==========================================
+ Hits         3458     3518      +60     
- Misses        378      382       +4     

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

README.md Show resolved Hide resolved
Copy link
Collaborator

@tomicapretto tomicapretto left a comment

Choose a reason for hiding this comment

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

Hi Julián! Thanks a lot for the contribution. Just left a couple of suggestions.

README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
docs/index.qmd Outdated Show resolved Hide resolved
docs/index.qmd Outdated Show resolved Hide resolved
docs/index.qmd Outdated Show resolved Hide resolved
@tomicapretto tomicapretto merged commit ec8ddce into bambinos:main Apr 1, 2024
4 checks passed
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.

4 participants