KarlHeitmann / KarlHeitmann/rg_explorer

Fix bad function names

Open
#8 0 comments 0 reactions 0 assignees View on GitHub
good first issue
Dominant language
Rust
Stars
6
Forks
0
PR merge metrics
No merged PRs in 30d

Description

There are a bunch of functions with weird, ambiguos and/or bad names. This is an issue I will never close, because I think these kind of bad names will never end. Just link the PR that address these kind of issues here, and describe in your PR what are you attending to fix. Below is a list of function names I will take note and you can take as example to refactor.

[ ] (run_wrapper)[https://github.com/KarlHeitmann/rg_explorer/blob/960bf90942896f78eee3eaf327e4fbf30b19235c/src/rip_grep/mod.rs#L93]: I introduced `run_wrapper` when I added the feature to edit the search_term of `RipGrep` struct by the `src/ui/edit.rs` ui. The idea was to wrap the [run](https://github.com/KarlHeitmann/rg_explorer/blob/960bf90942896f78eee3eaf327e4fbf30b19235c/src/rip_grep/mod.rs#L99) inside a wrapper. `run` function will perform the `rg` child process and update the `Nodes` of the `RipGrep` struct. But I don't wanted `run` to be called if the search_term didn't change at all. That's why I wrapped it into the `run_wrapper` function, `run_wrapper` will only execute `run` if search term is different than the `search_term_buffer`, the String that is manipulated on `src/ui/edit.rs`. Maybe someone has an idea for a better name to `run_wrapper` ? or this is unnecesary/overwhelming?

Contributor guide

No contributing guide indexed for this repository

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.