SWIFT-148: WriteConcern.description should return empty string on error #88
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
jmikola
commented
Jul 6, 2018
| guard let jsonData = json else { | ||
| return String() | ||
| guard let json = bson_as_canonical_extended_json(self.data, nil) else { | ||
| return "" |
There was a problem hiding this comment.
AFAIK, "" is equivalent to String() in this context. I opted for the string literal for consistency since I found no other uses of String() in the driver.
There was a problem hiding this comment.
yes, I prefer the literal as well
| let json = bson_as_canonical_extended_json(self.data, nil) | ||
| guard let jsonData = json else { | ||
| return String() | ||
| guard let json = bson_as_canonical_extended_json(self.data, nil) else { |
There was a problem hiding this comment.
This seemed trivial to inline and avoid the extra constant declaration without adding too much width to the line.
| } | ||
|
|
||
| /// Returns a canonical extended JSON representation of this `Document` | ||
| /// Returns the canonical extended JSON representation of this `Document`. | ||
| /// On error, an empty string will be returned. |
There was a problem hiding this comment.
This documentation now consistent across both JSON accessors and all three description accessors in the PR.
We can ignore ObjectId.description since that never returns an error, nor does it have a doc comment (I suppose it's inherited from the protocol).
kmahar
approved these changes
Jul 8, 2018
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
https://jira.mongodb.org/browse/SWIFT-148