rust-lang / rust-lang/rust

Come up with better names for `run_make_support` symbol helpers

Open
#143,933 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

A-run-make C-enhancement T-compiler
Dominant language
Rust
Stars
119k
Forks
16.1k
PR merge metrics
PR metrics pending

Description

When I was reading through the test cases, these function names seemed to blur into one another. object_contains_any_symbol_substring, object_contains_all_symbol_substring, object_contains_any_symbol and object_contains_all_symbols are all long names sometimes with only a few characters difference in the middle. So I could see mistakes being missed.

However, I don't have a clear idea of what would be an improvement here (hence why I don't want to block this). Maybe some more namespacing or an iterator type? Idk.

Originally posted by @ChrisDenton in https://github.com/rust-lang/rust/pull/143837#pullrequestreview-3016871479

I.e. less symbol (hah) soup names for

Substring match Exact match
Match any object_contains_any_symbol_substring object_contains_any_symbol
Match all object_contains_all_symbol_substring object_contains_all_symbols

Contributor guide

Open the contributing guide

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 run_make_support symbol helpers and the test cases that use object_contains_any_symbol_substring, object_contains_all_symbol_substring, object_contains_any_symbol, and object_contains_all_symbols. Compare the naming dimensions in the issue, then propose distinct names and update their references so the any/all and substring/exact meanings remain unambiguous.

Written by the indexing model from the issue text.

Assessment

Tech stack
rust
Domain
testing
Issue type
Refactor
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.