Lumped together titles+descriptions for overloaded functions#49
Lumped together titles+descriptions for overloaded functions#49mray190 wants to merge 2 commits intoTypeStrong:masterfrom
Conversation
…tles listed, and then the bodies listed
|
Is this possibly the result of #43 being broken? |
|
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. |
|
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 |
|
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. |
|
I can remove spelling commit to a separate PR if that is what is required to get this merged in |
Previous methodology had (for overloaded functions) all the overloaded function titles listed, and then all of the descriptions. Shown below:
This PR now lists each title+description pair so that users know what description belongs to which overloaded function. New format shown below: