HdrHistogram / HdrHistogram/HdrHistogram_rust

[Break Change] Rename APIs new_with_* to with_*

Open
#119 1 comment 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
Rust
Stars
372
Forks
50
PR merge metrics
No merged PRs in 30d

Description

In Rust's official naming guide, the recommanded constructor names should be new or with_more_details, and almost all stdlib APIs follow the guide.

This may introduce a break change so that a new major version should be released, feel free to close the issue if you think it's non-critical. This is only a suggestion.

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 by locating the public APIs named new_with_* and compare their intended replacements with Rust's API naming guide. Done means the affected APIs and their references use the agreed with_* names, with the breaking-change and major-version decision resolved.

Written by the indexing model from the issue text.

Assessment

Tech stack
rust
Domain
backend-api-design
Issue type
Refactor
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.