Skip to content

Rename dialog_pointer_* to dialog_highlight_* - #456

Merged
peterzhu2118 merged 1 commit into
ruby:masterfrom
st0012:rename-dialog-apis
Jul 22, 2022
Merged

Rename dialog_pointer_* to dialog_highlight_*#456
peterzhu2118 merged 1 commit into
ruby:masterfrom
st0012:rename-dialog-apis

Conversation

@st0012

Copy link
Copy Markdown
Member

"Pointer" is not what we usually use to describe a selected item.

"Highlight" is a more common word for the scenario so we should use it instead.

@st0012

Copy link
Copy Markdown
MemberAuthor

@peterzhu2118@nobu Wdyt?

@peterzhu2118

Copy link
Copy Markdown
Member

I don't really have a strong opinion on whether it should be called "pointer" or "highlight". Both terms make sense to me, "pointer" means the element that is pointed to, and "highlight" means the element that is highlighted, so I think either term makes sense.

@st0012

Copy link
Copy Markdown
MemberAuthor

Is it common to say a keyboard selected item "pointed"? I'd expect "pointed" to be cursor-related (which doesn't seem to work on reline's dialog). But maybe it's because of my limited English 😬

I'm fine with "pointer" in the context of reline. But I was trying to make a related PR in irb, which will expose these APIs to all Ruby users. And I think highlight will be clearer to most users compared to pointer. I can of course just name things in irb differently but I want to avoid that.

@peterzhu2118

Copy link
Copy Markdown
Member

I agree that "pointer" makes more sense in the context of a GUI with a mouse. 👍 I'm in favor of this PR.

Comment threadlib/reline/config.rb
"Pointer" is not what we usually use to describe a selected item.
"Highlight" is a more common word for the scenario so we should use it instead.
@st0012
st0012force-pushed the rename-dialog-apis branch from 9ab336f to b4279d1CompareJuly 21, 2022 15:55
@peterzhu2118
peterzhu2118 merged commit 9bc3353 into ruby:masterJul 22, 2022
@mame

mame commented Jul 22, 2022

Copy link
Copy Markdown
Member

I don't know much about reline but this is not just an internal name, but a name used in the configuration file, right? If so it's incompatible?

@st0012

Copy link
Copy Markdown
MemberAuthor

These apis/configs were newly added and haven’t been released yet

@st0012
st0012 deleted the rename-dialog-apis branch July 22, 2022 14:48
@mame

mame commented Jul 22, 2022

Copy link
Copy Markdown
Member

Oh I see. Thank you for the explanation.

@hsbthsbt mentioned this pull request Jul 27, 2022
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants

@st0012@peterzhu2118@mame