Improve Wording of Slice1 Custom Type Encoding #417
Merged
Conversation
This file contains 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
| @@ -54,8 +54,8 @@ public static class BigIntSliceEncoderExtensions | |||
| ``` | |||
|
|
|||
| {% slice1 %} | |||
| If you use this custom type as an optional (with a `?` suffix) outside of a tag context, you also need to supply methods | |||
| to encode/decode a nullable value of this type. With our example: | |||
| If this custom type is ever tagged or used as an optional type (with a `?` suffix), you also need to supply methods to | |||
There was a problem hiding this comment.
I find this clarification confusing. tagged implies optional. Why not a simpler:
if this customer type is even used as an optional (with a ? suffix), you also need to supply methods...
i.e. just remove the "outside of a tag context".
There was a problem hiding this comment.
I'll remove it.
I kept the distinction to be on the safe side. Yes, they both use the optional syntax, but in some places we make a distinction between optional (but not tagged) and 'pure' optional types.
But I've no problem with your suggestion.
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.
This is a companion PR to icerpc/icerpc-csharp#3929 and adjusts the docs accordingly.