kokkos / kokkos/mdspan

Update cppreference with mdspan

Open
#207 4 comments 1 reaction 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
C++
Stars
507
Forks
87
Avg merge
15h 27m
Merged PRs (30d)
2

Description

Hi! I am working with mdspan every now and then, so, naturally, I need to consult its documentation. I usually used P0009 as a reference, but since it was approved in WG21 plenary and merged to the C++ working draft, it has not been updated anymore. Several follow-up papers have been proposed and accepted in the meantime, so there is no longer a single up-to-date reference.

At some point I noticed someone started populating cppreference with mdspan: https://en.cppreference.com/w/cpp/container/mdspan. However, just the synopsis of std::mdspan is given. It would really help me as a user, if you could take a bit of time to add a synopsis for the related classes as well, e.g. for the layouts and accessors. Also, consider adding the individual pages for each member function so at least the up-to-date signature is browsable there.

I understand this may be quite time consuming, so maybe focus on just the content from the proposals for now. Examples can for sure be added later! Thank you!

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start with the existing cppreference std::mdspan page and compare it with P0009 and the accepted follow-up proposals. Add synopses for related classes such as layouts and accessors, then create browsable pages for their member functions with up-to-date signatures. Done means the relevant proposal content is represented; examples are explicitly optional.

Written by the indexing model from the issue text.

Assessment

Tech stack
cpp
Domain
documentation
Issue type
Documentation
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.