Skip to content
New issue

Have a question about this project? # for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “#”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? # to your account

Add doctests and update docs #288

Merged
merged 13 commits into from
Dec 22, 2024
Merged

Add doctests and update docs #288

merged 13 commits into from
Dec 22, 2024

Conversation

abhro
Copy link
Contributor

@abhro abhro commented Dec 19, 2024

Checklist

  • Appropriate tests were added
    • To fix a failing doctest, an implementation of Base.show() was changed (735ea5e), which is covered by said doctest (b79465c)
  • 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

Main changes:

  • Update GitHub repository owner name (jonniedie -> SciML)
  • Turn almost every code example into a doctest (this revealed some inconsistencies between presented documentation and observed behavior)

@abhro abhro marked this pull request as draft December 19, 2024 16:15
@abhro abhro marked this pull request as ready for review December 19, 2024 16:24
@ChrisRackauckas ChrisRackauckas merged commit 022f6df into SciML:main Dec 22, 2024
2 of 5 checks passed
@ChrisRackauckas
Copy link
Member

Thanks!

# for free to join this conversation on GitHub. Already have an account? # to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants