Disambiguate functions and variables in Elisp

Question

Disambiguate functions and variables in Elisp

minad opened this issue a year ago · comments

If there exists a function and variable in Elisp with the same name, they are not disambiguated automatically by Embark. Consider the following docstring:

"In docstrings the convention is to write the variable `jinx-languages'
or the function `jinx-languages', while checkdoc will warn if plain
`jinx-languages` is mentioned."

It would be nice to perform an automatic disambiguation in this case if possible. Do you think it makes sense to add this or is this another waste of time? Maybe this is too much of an edge case. 😉

Omar Antolín Camarena · Answer 1 · Sat Nov 11 2023 21:06:17 GMT+0800 (China Standard Time)

I think Embark will currently find both target types at each occurrence. Are you suggesting returning only one type depending on context, or just changing the priority so that the type mentioned in the surrounding text comes first?

Daniel Mendler · Answer 2 · Sat Nov 11 2023 21:40:47 GMT+0800 (China Standard Time)

I think if the context uniquely specifies the type, only that type should be returned or at least it should be prioritized.

Daniel Mendler · Answer 3 · Sun Nov 12 2023 00:34:14 GMT+0800 (China Standard Time)

We could take the bounds in `embark-target-identifier-at-point` and look back for "variable `" or "function `" if the mode is Elisp and the position is inside a string. If the current point is inside a string can be determined with `(nth 3 (syntax-ppss))`, which is non-nil then. Then the respective type should be prioritized.

Omar Antolín Camarena · Answer 4 · Sun Nov 12 2023 08:50:00 GMT+0800 (China Standard Time)

Sure, but maybe it would be worth it to list more contexts that disambiguate type: let means it's the variable, symbol-function and #' mean it's the function, etc.

Daniel Mendler · Answer 5 · Sun Nov 12 2023 14:24:27 GMT+0800 (China Standard Time)

Indeed. This would be nice.

Daniel Mendler · Answer 6 · Sun Nov 12 2023 20:00:47 GMT+0800 (China Standard Time)

Trying to detect the context everywhere is a lot of work, and all of this only to disambiguate. Reusing a name for variables and functions is not that common, so it doesn't seem worth to do this.