oneapi-src / oneDPL

oneAPI DPC++ Library (oneDPL) https://software.intel.com/content/www/us/en/develop/tools/oneapi/components/dpc-library.html
Apache License 2.0
722 stars 113 forks source link

[oneapi][doc][spec] To add the details about alias "namespace dpl = oneapi::dpl" to the spec or(and) the doc #564

Closed MikeDvorskiy closed 1 month ago

MikeDvorskiy commented 2 years ago

(2) - @ValentinaKats Could you please add details about alias "namespace dpl = oneapi::dpl" to the OneAPI spec or(and) oneAPI documentation?

_Originally posted by @SergeyKopienko in https://github.com/oneapi-src/oneDPL/pull/558#discussion_r832914117_

akukanov commented 2 months ago

This is what the specification says (https://oneapi-spec.uxlfoundation.org/specifications/oneapi/latest/elements/onedpl/source/common):

oneDPL uses namespace oneapi::dpl and a shorter variant namespace dpl for all functionality including parallel algorithms, oneDPL execution policies, etc.

If you think it needs to be clarified, please suggest how (with some wording or at least a direction).

The documentation does not say anything about the namespace dpl. This is what it has as a general description (https://oneapi-src.github.io/oneDPL/introduction.html):

oneDPL introduces the namespace oneapi::dpl for most its classes and functions.

For many APIs their namespace (usually namespace oneapi::dpl) is explicitly mentioned. A few examples use dpl:: together with using namespace oneapi; directive (which I want to get rid of, honestly).

Same request: if you have an idea what to improve in that regard in the library guide, please provide feedback.

@SergeyKopienko @danhoeflinger @timmiesmith @rarutyun

SergeyKopienko commented 2 months ago

My assumption - we may have in documentation some list of public Namespase aliases :

I mean users should have some list of that.

akukanov commented 1 month ago

https://github.com/oneapi-src/oneDPL/pull/1825 adds a note to introduction.rst. Good enough?

SergeyKopienko commented 1 month ago

1825 adds a note to introduction.rst. Good enough?

Yes, I think so. Thanks.