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

Add brief example on main doc page to give a "feel" of the package #25

Merged
merged 1 commit into from
Jun 20, 2023

Conversation

DominiqueMakowski
Copy link
Contributor

I personally like it when you can see an example straight up without having to navigate the docs too much. But feel free to edit or close if you have other preferences I won't take it personally ☺️

@codecov-commenter
Copy link

Codecov Report

Patch and project coverage have no change.

Comparison is base (e012bd3) 78.07% compared to head (18c230d) 78.07%.

Additional details and impacted files
@@           Coverage Diff           @@
##           master      #25   +/-   ##
=======================================
  Coverage   78.07%   78.07%           
=======================================
  Files          10       10           
  Lines         552      552           
=======================================
  Hits          431      431           
  Misses        121      121           

☔ View full report in Codecov by Sentry.
📢 Do you have feedback about the report comment? Let us know in this issue.

@itsdfish
Copy link
Owner

@DominiqueMakowski, thanks for the PR. I like the idea of including a simple example in the home page of the docs. I will merge this and make a few minor adjustments (mostly I will use the ```@example macro so that the plots display.

@itsdfish itsdfish merged commit 668a68b into itsdfish:master Jun 20, 2023
3 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.

3 participants