swiftlang/swift

[SR-10291] Some of the error messages might require trimming

Open

#52,691 opened on Apr 3, 2019

View on GitHub
 (6 comments) (0 reactions) (0 assignees)Swift (69,989 stars) (10,719 forks)batch import
bugcompilerdiagnostics qualitygood first issue

Description
Previous ID SR-10291
Radar rdar://problem/49393677
Original Reporter @xedin
Type Bug
Votes 0
Component/s Compiler
Labels Bug, DiagnosticsQoI, StarterBug
Assignee None
Priority Medium

md5: 59ddf07a63039e0c74cd437ae791689d

Issue Description:

Consider following example:

func foo(_: UnsafePointer<Int8>?) {}
foo((1, 2, 3))

This results in:

cannot convert value of type '(Int, Int, Int)' to expected argument type 'UnsafePointer<Int8>?'

So the more elements to the tuple we add, the bigger the message is going to get.

I think it makes sense to trim contents of the tuple which has same types to something like `(Int8, ..., Int8)` to make sure that it doesn't grow too long.

Contributor guide

Tech stack
swift
Domain
developer experience
Issue type
bug
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
stale
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
clear
Prerequisites
Swift programming
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
75
Research direction
To implement this fix, explore the Swift compiler's diagnostic formatting code, likely in 'lib/AST/Diagnostics.cpp' or similar files. The issue describes trimming tuple types in error messages when all elements have the same type. Look for functions that convert types to strings for diagnostics, and add logic to abbreviate tuples with repeated types (e.g., '(Int, ..., Int)'). Check for any existing truncation patterns in the codebase.