lincc-frameworks / lincc-frameworks/asv-formatter
(maybe) strip out redundant parts of method name
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 2
- Forks
- 0
- PR merge metrics
- No merged PRs in 30d
Description
Currently, the method name will read something like
```
665±4ms | 658±4ms | 0.99 | benchmarks.time_test_cone_filter_multiple_order
185±7ms | 179±2ms | 0.97 | benchmarks.time_test_alignment_even_sky
```
but `cone_filter_multiple_order` and `alignment_even_sky` are the meaningful bits of the method name.
Prefixes that would be stripped out:
- `benchmarks.` or `benchmark.`
- `time_`
- `test_`
- `mem_`
- `peakmem_`
Alternatively, we could do keep things as they are.
Contributor guide
No contributing guide indexed for this repository
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start by locating the script or entry point that formats ASV outputs and assembles the displayed method name. Compare its output with the examples in the issue, then confirm whether the listed prefixes should be removed while preserving the meaningful suffix; the issue's alternative of keeping the current format needs a decision before implementation.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- tooling
- Issue type
- Feature
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100