Translate DS array to NET array for description #11040
Merged
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
This fixes a bug where the description of Curve.SplitByParameter in the library would show up a description of an obsoleted overload. The cause of the issue was the inability of XmlDocumentationExtensions to handle conversion from primitve DS arrays to their equivalent .NET arrays. This made the module unable to find the exact overload, so it resorted to a fallback which returns the first overload available, which in this case was the incorrect one. The problem is fixed for this particular instance, as it is now able to find the exact overload. Note, however, that the mechanism is not bullet-proof, as there is no guaranteed way to translate back a type from DS to the original .NET type.
| case "double": | ||
| return "System.Double"; | ||
| case "double[]": | ||
| return "System.Double[]"; |
Contributor
There was a problem hiding this comment.
@mmisol this could also be an IEnumerable or IList, etc., right? Is that why you say this is not foolproof?
aparajit-pratap
approved these changes
Aug 24, 2020
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.
Purpose
This fixes a bug where the description of Curve.SplitByParameter in the
library would show up a description of an obsoleted overload.
The cause of the issue was the inability of XmlDocumentationExtensions
to handle conversion from primitve DS arrays to their equivalent .NET
arrays. This made the module unable to find the exact overload, so it
resorted to a fallback which returns the first overload available,
which in this case was the incorrect one.
The problem is fixed for this particular instance, as it is now able to
find the exact overload. Note, however, that the mechanism is not
bullet-proof, as there is no guaranteed way to translate back a type
from DS to the original .NET type.
Declarations
Check these if you believe they are true
*.resxfilesReviewers
@aparajit-pratap @QilongTang
FYIs
@DynamoDS/dynamo