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

Correct ScatterViews template parameters order #614

Open
wants to merge 2 commits into
base: main
Choose a base branch
from

Conversation

PaulGannay
Copy link

Trying to instantiate a ScatterView while specifying its template parameters didn't work as written in the doc.
You can check it here: https://godbolt.org/z/Me1jKezjq

Also added a small description on how to use ScatterView and a description for each template parameter (copied from the cheatsheet).
All of this descriptions may be wrong and need to be checked by someone more familiar with ScatterViews.

Also added a small description on how to use ScatterView and added a
description for the templates parameters (copied from the
cheatsheet one).
* ``DataType``:
Works the same as a |View|_'s DataType.

* ``Layout``:

Choose a reason for hiding this comment

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

Description regarding Layout.

Copy link
Author

@PaulGannay PaulGannay Jan 27, 2025

Choose a reason for hiding this comment

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

I'm not sure of what to write here, I wonder what happens if we pass a Layout (or DataType, or ExecutionSpace) that is different from the one of the underlying view: is it allowed under some circumstances, does it breaks anything ?
This is the main point where I think it would be important to have the opinion of someone familiar with ScatterViews.

Copy link
Member

@tpadioleau tpadioleau left a comment

Choose a reason for hiding this comment

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

LGTM, Just a minor change.

Could you check the example compiles fine ?

docs/source/API/containers/ScatterView.rst Show resolved Hide resolved
Created hyperlinks to function from usage section
Ensured example compile without change
Moved Warning about namespace to the top of the file
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