Documentation improvements: Complete method ambiguity explanation #56
Conversation
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
- Complete the explanation about avoiding method ambiguity in README.md and docs/src/index.md, which previously ended abruptly - Add clarification that either the problem or algorithm type must be defined in the package to avoid type piracy - Fix minor spacing/formatting issues for consistency - Fix double space in "the type" -> "a type" 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude Sonnet 4.5 <noreply@anthropic.com>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 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 by completing an explanation that was previously left incomplete.
Changes Made
Completed method ambiguity explanation: Both
README.mdanddocs/src/index.mdpreviously ended with "do not define a method such as" followed by a code example, but never explained why or what to do instead. Added clarification that either the problem or algorithm type must be defined in the package to avoid type piracy and method ambiguities.Fixed minor formatting issues:
docs/src/index.mdTesting
julia --project make.jlVerification
The documentation now provides complete guidance on avoiding method ambiguity, which is important for package developers implementing the CommonSolve interface.
cc: @ChrisRackauckas
🤖 Generated with Claude Code