document known speedy isobased pruning limitation #128
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
Removed duplicate documentation links and added known issues reference.
Collaborator
|
Hi @shreyadesai20042009, thank you for your PR. We appreciate the time and effort that was put into it but, unfortunately, we have to decline the PR as the added value to the tool is limited and does not justify a PR. |
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.
This PR documents a known limitation of the
speedy_isobasedroutingalgorithm when using the provided test weather and depth datasets.
The routing may terminate early with all pruning segments constrained,
even though no runtime error occurs. This change explains the symptoms,
likely cause, and suggests parameter workarounds to help new users
understand and mitigate the behavior.
Related issue: #105