[Repo Assist] Improve type alias tooltip: show abbreviation signature as fallback#1516
Draft
github-actions[bot] wants to merge 2 commits intomainfrom
Draft
Conversation
When GetAbbreviatedParent() fails (e.g. for cross-assembly type aliases, or when the abbreviated entity is not an FSharpEntity), fall back to showing the type abbreviation's own signature using getEntitySignature directly on the alias entity. Previously the TypeAbbreviation case returned None on any failure, resulting in no tooltip/documentation for type aliases. Now users will see at minimum the abbreviation definition itself, e.g.: type StringPair = string * string Partially addresses #914 Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
Member
|
/repo-assist add tests for this |
Contributor
Author
|
✗ Repo Assist encountered failed at {run-ended}. |
29 tasks
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
🤖 This PR was created by Repo Assist, an automated AI assistant.
Summary
Partially addresses #914 — improves tooltip/hover display for type aliases by providing a fallback signature when
GetAbbreviatedParent()fails.Root Cause
As identified by
@baronfelin #914,fse.GetAbbreviatedParent()throws for certain type aliases (particularly those that resolve to tuples, primitives, or cross-assembly types that FCS doesn't represent asFSharpEntitysymbols). When this happens, theTypeAbbreviationhandler inDocumentationFormatter.fscatches the exception and returnsNone, resulting in no tooltip at all for those type aliases.Fix
When
GetAbbreviatedParent()fails or returns a non-entity, fall back to callinggetEntitySignaturedirectly on the abbreviation entityfse. This produces a signature like:The
getEntitySignaturefunction already has this branch (checkingIsFSharpAbbreviation) — we just weren't using it as a fallback before.What remains unresolved
The full fix for #914 (clickable links to the abbreviated type, full documentation of the parent type) would require FCS changes to expose type alias entities properly. This PR improves the user experience in the common case by showing something useful rather than nothing.
Test Status
✅ Build succeeded (
dotnet build src/FsAutoComplete/FsAutoComplete.fsproj -f net8.0)✅ General unit tests passed
Full test suite was not run locally — CI will validate.