NVIDIA / NVIDIA/cccl

Documentation inconclusive for `result_of` and `<cuda/std/type_traits>`

Open
#1,022 0 comments 0 reactions 0 assignees View on GitHub
Dominant language
C++
Stars
2.5k
Forks
486
Avg merge
2d 6h
Merged PRs (30d)
295

Description

I searched the libcudacxx docs for `result_of` but didn't get any results.
![image](https://github.com/NVIDIA/libcudacxx/assets/3943761/5bdf4318-bf20-4cfb-8fa9-9fdf64e8d327)

After some time, I was able to find this page: https://nvidia.github.io/libcudacxx/standard_api/utility_library.html

However, `` appears to be missing from the sidebar.
![image](https://github.com/NVIDIA/libcudacxx/assets/3943761/c7d3a4a5-6157-4cdb-b498-5a25c935f8e0)

In my understanding, `std::result_of` won't correctly check device lambda return types in host code, but `cuda::std::result_of` will check this and require `cuda::proclaim_return_type` (#284). This is the kind of difference that I would like to see documented.

It seems like the libcudacxx docs might expect users to look at both libcudacxx docs _and_ cppreference to figure out what headers contain a given functionality. I would prefer that libcudacxx docs are self-contained and link out for supporting information but not for discovering the contents of a given header. I'm not quite sure what libcudacxx docs are intended to provide, so I'm not sure what PR I could file to improve the situation.

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.