jazzy icon indicating copy to clipboard operation
jazzy copied to clipboard

Show types if parameter labels are not sufficient to disambiguate

Open reitzig opened this issue 8 years ago • 2 comments

Currently, documentation generated from code like this:

struct Foo {
	init(_ id: Int) { ... }
	init?(_ json: String { ... }
}

looks like this:

screen shot 2017-04-26 at 14 25 01

This is not very helpful.

If function name and parameter labels are not enough to disambiguate (detect by string equality), we need to see parameter and/or return types.

I for one would appreciate a setting that enables showing types "everywhere", but an automatism that shows as little as possible would make a lot of sense, imho.

(Arguably, the ? should always carry over!)

reitzig avatar Apr 26 '17 12:04 reitzig

+1 We would like this as well (Kitura.io)

lroseblade avatar Nov 29 '17 15:11 lroseblade

Agreed on all counts.

jpsim avatar Nov 29 '17 19:11 jpsim