boostorg / boostorg/hana

Documentation of `hana::apply` should link to `hana::unpack`

Open
#469 0 comments 1 reaction 0 assignees View on GitHub
Dominant language
C++
Stars
1.9k
Forks
225
PR merge metrics
No merged PRs in 30d

Description

I have read the rationale behind the naming (and parameter order) of `unpack`. I agree with the parameter order, and I have no strong feelings about the name. However, whenever I need `unpack`, I cannot recall its name, only finding `apply` in my memory. I suspect that there are other people around who are more accustomed to `apply` than `unpack`. Maybe a cross-link in the documentation could help here?

Contributor guide

Open the contributing guide

Research direction

Read the documentation for hana::apply and hana::unpack first. Add a cross-link from the hana::apply documentation to hana::unpack, then verify that the link is present and points to the correct documentation entry.

Written by the indexing model from the issue text.

Assessment

Tech stack
cpp
Domain
documentation
Issue type
Documentation
Difficulty
1/5
Estimated time
Under an hour
Activity status
Stale
Clarity
Clearly specified
Newbie friendliness
50/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.