Inconsistent parameter names for erase members of unordered containers

Open Beginner friendly
#8,904 2 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
2/5
Estimated time
1-3 hours
Newbie friendliness
68/100
Issue type
Documentation
Clarity
Mostly clear
Activity status
Quiet
Tech stack
cpp
Domain
documentation

Research direction

Search the draft for the unordered-container erase declarations and compare their parameter names with the associative-container and flat-map/set declarations. Choose the consistent naming convention described in the issue, update the relevant standard wording, and verify that all affected erase declarations use the same convention.

Written by the indexing model from the issue text.

Description

P2-Bug

The associative containers and the flat maps and sets all have:

    constexpr size_type erase(const key_type& x);
    template<class K> constexpr size_type erase(K&& x);

But the unordered containers have k and x for the same functions:

    constexpr size_type erase(const key_type& k);
    template<class K> constexpr size_type erase(K&& x);

This seems unnecessarily inconsistent. Either the unordered should use k for both (to be locally consistent), or use x for both (to be globally consistent).

Dominant language
TeX
Stars
221
Forks
813
Avg merge
16h 4m
Merged PRs (30d)
36

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.

More from cplusplus/draft

All issues in cplusplus/draft

Similar issues

More Documentation issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.