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

sycl namespace #72

Open
mkinsner opened this issue Oct 6, 2023 · 1 comment
Open

sycl namespace #72

mkinsner opened this issue Oct 6, 2023 · 1 comment

Comments

@mkinsner
Copy link

mkinsner commented Oct 6, 2023

The reference assumes using namespace sycl; in synopses and text.

@keryell suggested that instead namespaces should be explicit everywhere. Should we make them explicit in both the code snips and all the text within SYCL_Reference, or only in the code snips?

Currently we're mixing styles. For example:

image

image

@gmlueck
Copy link
Contributor

gmlueck commented Oct 6, 2023

We could expand the synopsis at the top of the page. For example, old is:

class platform;

New could be:

namespace sycl {

class platform {
 public:
  platform();

  template <typename DeviceSelector> explicit platform(const DeviceSelector&);

  backend get_backend() const noexcept;

  template <typename Param>
  typename Param::return_type get_info() const;

  template <typename Param>
  typename Param::return_type get_backend_info() const;

  bool has(sycl::aspect asp) const;

  bool has_extension(const std::string& extension) const;

  std::vector<device> get_devices(info::device_type deviceType = info::device_type::all) const;

  static std::vector<platform> get_platforms();
};

} // namespace sycl

Of course, this causes the synopsis to have duplicate declarations of all the member functions shown later in the page. Is that what you had in mind?

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

No branches or pull requests

2 participants