typedoc-default-themes icon indicating copy to clipboard operation
typedoc-default-themes copied to clipboard

Lumped together titles+descriptions for overloaded functions

Open mray190 opened this issue 8 years ago • 5 comments
trafficstars

Previous methodology had (for overloaded functions) all the overloaded function titles listed, and then all of the descriptions. Shown below:

orig

This PR now lists each title+description pair so that users know what description belongs to which overloaded function. New format shown below:

new

mray190 avatar May 02 '17 21:05 mray190

Is this possibly the result of https://github.com/TypeStrong/typedoc-default-themes/pull/43 being broken?

blakeembrey avatar May 03 '17 15:05 blakeembrey

Although this would be the preferred fix overall (especially for non-JS users), I'd like to ensure we don't break the JavaScript functionality.

blakeembrey avatar May 03 '17 15:05 blakeembrey

Thanks for the PR. The spelling error should probably be a separate PR (see #68).

Do we have any typedoc tests demonstrating how the rendering would be affected by this PR? A corresponding PR to see the results would be helpful (though not required).

I'm not sure what @blakeembrey's comments are referring to. This doesn't have any impact on client.js users

aciccarello avatar May 19 '19 22:05 aciccarello

It looks like this change would improve the user experience for overloaded functions when JavaScript is disabled in the browser. If I go to https://typedoc.org/api/classes/bindingarrayconverter.html#off with JavaScript disabled, I see the behavior in mray's first screenshot.

Gerrit0 avatar May 20 '19 01:05 Gerrit0

I can remove spelling commit to a separate PR if that is what is required to get this merged in

mray190 avatar May 20 '19 15:05 mray190