neogit icon indicating copy to clipboard operation
neogit copied to clipboard

Improve naming convention of configuration parameters for better readability

Open D00mch opened this issue 1 year ago • 4 comments

I'd like to suggest re-evaluating the naming convention for certain configuration parameters. Currently, the parameters use "disable" as a prefix, which increases cognitive load when interpreting their values.

“disable_*=false“ is like a negation of negation (two operation to get the meaning).

Using an “enable_*“ prefix would make it more intuitive and easy to get.

Parameters:

disable_context_highlighting
disable_hint
disable_insert_on_commit 
disable_line_numbers
disable_signs

D00mch avatar Nov 10 '24 13:11 D00mch

Totally agreed - these are just kinda legacy from before I took over. I'm open to changing them, but won't have time for a while. I brought twins home from the hospital juuuuust a few hours ago 😅

So, if you wanna do it, be my guest. Otherwise... no worries, it'll be a minute though.

CKolkey avatar Nov 10 '24 15:11 CKolkey

I will make a PR today

D00mch avatar Nov 10 '24 16:11 D00mch

This seems like it's related to #227 as well.

ktsujister avatar Dec 02 '24 04:12 ktsujister

Updated the PR, merged conflicts

D00mch avatar Dec 07 '24 21:12 D00mch