Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fix bad function names #8

Open
KarlHeitmann opened this issue Jan 12, 2023 · 0 comments
Open

Fix bad function names #8

KarlHeitmann opened this issue Jan 12, 2023 · 0 comments
Labels
good first issue Good for newcomers

Comments

@KarlHeitmann
Copy link
Owner

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 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?

@KarlHeitmann KarlHeitmann added the good first issue Good for newcomers label Jan 12, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
good first issue Good for newcomers
Projects
None yet
Development

No branches or pull requests

1 participant