Documentation improvements: Fix typos, grammar, and update links#167
Merged
ChrisRackauckas merged 1 commit intoJan 1, 2026
Conversation
- Fix typo: "Collab" → "Colab" (Google Colab is the correct name) - Update HTTP links to HTTPS for all docs.sciml.ai references - Improve grammar: "lesser loading time" → "a shorter loading time" - Improve grammar: "In case only" → "If only" with proper comma - Add missing period after pyjulia limitation link - Improve DAE example: Remove confusing error comment and add clear note that de.jit() is not supported for DAE problems - Update tox documentation link to HTTPS 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude Sonnet 4.5 <noreply@anthropic.com>
Merged
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
This PR improves the documentation quality in the README with focused, practical fixes:
de.jit()is not currently supported for DAE problemsAll changes are focused on improving clarity and correctness without altering the technical content or examples. The examples remain consistent with the test suite.
Test Plan
diffeqpy/tests/test_ode.py🤖 Generated with Claude Code
cc @ChrisRackauckas