Add API docs for StaticArray #6404
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
wooster0
reviewed
Jul 17, 2018
src/static_array.cr
Outdated
| @@ -1,4 +1,26 @@ | |||
| # A fixed-size, stack allocated array. | |||
| # | |||
| # `StaticArray` is a generic type with type argument `T` specifying the type of | |||
| # it's elements and `N` the fixed size. For example `StaticArray(Int32, 3)` | |||
There was a problem hiding this comment.
I think "its" instead of "it's" is correct here.
fba921f to
c2aa4a9
Compare
RX14
approved these changes
Jul 18, 2018
jhass
approved these changes
Jul 18, 2018
vlazar
reviewed
Jul 18, 2018
| @@ -1,4 +1,26 @@ | |||
| # A fixed-size, stack allocated array. | |||
| # | |||
| # `StaticArray` is a generic type with type argument `T` specifying the type of | |||
| # its elements and `N` the fixed size. For example `StaticArray(Int32, 3)` | |||
There was a problem hiding this comment.
Shouldn't it be
its elements and
Nis the fixed size.
There was a problem hiding this comment.
This is a deliberate omission. The second part of the sentence contains an elliptical construction (it would be specifying).
There was a problem hiding this comment.
@straight-shoota Thanks for explanation. TIL.
asterite
requested changes
Jul 18, 2018
src/static_array.cr
Outdated
| # ``` | ||
| # | ||
| # The generic argument type `N` is a special case in the type grammar as it | ||
| # doesn't specify a type but a size. It's value can be an `Int32` literal or |
15d9068 to
512964f
Compare
Added an example for use with `uninitialized`
512964f to
7996cd5
Compare
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.
No description provided.