search

dotnet / fsharp

The F# compiler, F# core library, F# language service, and F# tooling integration for Visual Studio
https://dotnet.microsoft.com/languages/fsharp
MIT License
3.88k stars 783 forks source link

Rename "inline hints" to "inlay hints" #16608

Open MariaSolOs opened 8 months ago

MariaSolOs commented 8 months ago

For consistency with LSP and VS Code, user visible references to "inline hints" should use "inlay hints" instead.

Related change in Roslyn: https://github.com/dotnet/roslyn/pull/71855

bmitc commented 4 months ago

I did a search for inline .* hints in the F# repository and came across the following terms:

  1. inline hints
  2. inline type hints
  3. inline parameter name hints

I don't know if there are more.

Questions:

  1. @MariaSolOs Should "inline" be replaced with "inlay" in all three of these?
  2. @MariaSolOs Is this the relevant documentation for inlays? https://microsoft.github.io/language-server-protocol/specifications/lsp/3.17/specification/#textDocument_inlayHint
  3. Where else would need these changes? Any documentation outside of the F# repository?

To me, it would seem best that any change like this would change the code as well and not just documentation and user facing strings.

MariaSolOs commented 4 months ago

Questions:

  1. @MariaSolOs Should "inline" be replaced with "inlay" in all three of these?

That's the goal.

  1. @MariaSolOs Is this the relevant documentation for inlays? https://microsoft.github.io/language-server-protocol/specifications/lsp/3.17/specification/#textDocument_inlayHint

Yes.

  1. Where else would need these changes? Any documentation outside of the F# repository?

This issue is scoped to this repository only, so don't worry about that.

To me, it would seem best that any change like this would change the code as well and not just documentation and user facing strings.

Agreed, but huge renames like these might involve a huge refactor which I leave to the core maintainers of this repo to decide if it's worth it.

bmitc commented 4 months ago

Thanks for the clarifications! Just wanted to make sure all three of those were in the same category.

Using the web-based VS Code on the F# repository and searching for the regular expression inline.*hints yields 185 entries, so it doesn't seem too bad to do it all in one go. Only 40 of them, across 10 files, are in .fs files.

I'd be willing to make this change. It seems like effectively a find and replace and then 🤞 that tests pass task (?), from what I can tell.