Update View documentation #21
Closed
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
dalg24
reviewed
May 16, 2022
| @@ -41,8 +41,10 @@ Template parameters other than `DataType` are optional, but ordering is enforced | |||
| ### Enums | |||
|
|
|||
| * `rank`: rank of the view (i.e. the dimensionality). | |||
| * `Rank`: rank of the view (i.e. the dimensionality) (use `rank` instead). | |||
There was a problem hiding this comment.
Do you really want to document something we don't want people to use?
| reference_type operator[] (const IntType& i) const | ||
| ``` | ||
| Returns a value of `reference_type` which may or not be referenceable itself. | ||
| See notes on `reference_type` for properties of the return type. |
There was a problem hiding this comment.
Say it is only available for rank-1 views
| * `HostMirror`: compatible view type with the same `DataType` and `LayoutType` stored in host accessible memory space. | ||
| * `non_const_type`: this view type with all template parameters explicitly defined. | ||
| * `host_mirror_type`: compatible view type with the same `DataType` and `LayoutType` stored in host accessible memory space. | ||
| * `HostMirror`: compatible view type with the same `DataType` and `LayoutType` stored in host accessible memory space (use `host_mirror_type` instead). |
There was a problem hiding this comment.
Same question about documenting deprecated things
|
please update this so that you use the sphinx branch |
masterleinad
requested changes
Aug 1, 2022
|
Closing in favor of #155 |
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.