Skip to content
New issue

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

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

Already on GitHub? Sign in to your account

Fix ValueFactory return signature #45

Merged
merged 3 commits into from
Jan 15, 2020
Merged

Conversation

simonz-bq
Copy link
Contributor

The return signatures of the factory constructors should've been updated to return IIonValue when the tree was collapsed.

Copy link
Contributor

@tgregg tgregg left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Good change. In the documentation for each of the interface methods please add a note that specifies which interface methods are implemented by the returned IIonValue instance. For example:

        /// Constructs a new {@code null.blob} instance.
        /// </summary>
        /// <returns>A new {@code null.blob} instance, which implements the IIonBlob interface methods.</returns>
        IIonValue NewNullBlob();

Also, this is unrelated to this change, but it doesn't look like the {@code ...} tags are valid in C# documentation comments. We might want to fix those while we're at it. Looks like <c></c> is the alternative. It would also be good for references to interfaces to be links, but I haven't looked deeply enough at the documentation comments documentation to know the best way to do that yet.

Copy link
Contributor

@tgregg tgregg left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I will merge this once the incomplete tag is fixed.

IonDotnet/Tree/IValueFactory.cs Outdated Show resolved Hide resolved
@tgregg tgregg merged commit 9a32939 into amazon-ion:master Jan 15, 2020
@tgregg tgregg mentioned this pull request Jan 15, 2020
@R-maan R-maan deleted the AQ-200 branch January 16, 2020 01:52
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants