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

Wrote documentation website #28

Merged
merged 34 commits into from
Jun 13, 2024
Merged

Wrote documentation website #28

merged 34 commits into from
Jun 13, 2024

Conversation

nicholaskl97
Copy link
Collaborator

@nicholaskl97 nicholaskl97 commented Jun 6, 2024

Checklist

  • Appropriate tests were added
  • Any code changes were done in a way that does not break public API
  • All documentation related to code changes were updated
  • The new code follows the
    contributor guidelines, in particular the SciML Style Guide and
    COLPRAC.
  • Any new documentation only uses public API

Additional context

Organized documentation website, rewrote many docstrings, changed the names of a few struct fields for greater clarity, sped up some of the test cases and used them as demonstrations in the documentation.

@nicholaskl97 nicholaskl97 marked this pull request as draft June 6, 2024 16:55
Copy link

codecov bot commented Jun 10, 2024

Codecov Report

Attention: Patch coverage is 75.00000% with 1 line in your changes missing coverage. Please review.

Project coverage is 76.95%. Comparing base (1ee202f) to head (db9e358).
Report is 1 commits behind head on master.

Files Patch % Lines
src/decrease_conditions.jl 50.00% 1 Missing ⚠️
Additional details and impacted files
@@            Coverage Diff             @@
##           master      #28      +/-   ##
==========================================
+ Coverage   76.63%   76.95%   +0.31%     
==========================================
  Files          10       10              
  Lines         244      243       -1     
==========================================
  Hits          187      187              
+ Misses         57       56       -1     

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

@nicholaskl97 nicholaskl97 marked this pull request as ready for review June 12, 2024 18:43
@nicholaskl97
Copy link
Collaborator Author

@ChrisRackauckas, here's the documentation that you suggested I work on. If I remember correctly, you wanted to take a look at it once I had written it.

Signed-off-by: Christopher Rackauckas <accounts@chrisrackauckas.com>
@ChrisRackauckas ChrisRackauckas merged commit ab3f142 into master Jun 13, 2024
3 of 4 checks passed
@ChrisRackauckas ChrisRackauckas deleted the documentation branch June 13, 2024 09:55
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