fsharp / fsharp/emacs-fsharp-mode

Eldoc truncated examples

Open
#339 1 comment 0 reactions 0 assignees View on GitHub
Dominant language
Emacs Lisp
Stars
215
Forks
65
PR merge metrics
No merged PRs in 30d

Description

### Description

I am learning F# on Emacs and my experience has been great. Thank you for your work!

A little annoyance (at least for a F# newbie) is that documentation examples get truncated by Eldoc:

This seems [to come from FsAutoComplete](https://github.com/fsharp/FsAutoComplete/blob/4bc676cc1e8659d9338d31d82d6244bcfcc55cc4/src/FsAutoComplete.Core/TipFormatter.fs#L1245) but I am not sure what causes it.
I appreciate taht this could not be due to this project, in case an hint on what could be the root case could be helpful.

If this can help, I tried installing Ionide on VScode and the examples section seems to appear in the documentation.

### Repro steps

Please provide the steps required to reproduce the problem

1. hover a function (like 'Map.find)
2. invoke eldoc-doc-buffer
3. the documentation appear as expected but the examples section is truncated with a link and a message.
`Open the documentation to see the truncated examples`

### Related information

Linux
Emacs 29.2
Dotnet 8.0.3

Contributor guide

No contributing guide indexed for this repository

Research direction

Reproduce the issue in Emacs 29.2 by hovering `Map.find` and invoking `eldoc-doc-buffer`, then compare the displayed examples with Ionide in VS Code. Inspect the linked FsAutoComplete `TipFormatter.fs` location and determine whether truncation originates there or in emacs-fsharp-mode. Done means identifying the responsible component and documenting or fixing the truncated examples.

Written by the indexing model from the issue text.

Assessment

Tech stack
emacs, fsharp
Domain
developer-experience
Issue type
Bug
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.