Skip to content
This repository has been archived by the owner on Aug 14, 2021. It is now read-only.

Lumped together titles+descriptions for overloaded functions #49

Open
wants to merge 2 commits into
base: master
Choose a base branch
from

Conversation

mray190
Copy link

@mray190 mray190 commented May 2, 2017

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

@blakeembrey
Copy link
Member

Is this possibly the result of #43 being broken?

@blakeembrey
Copy link
Member

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.

@aciccarello
Copy link
Contributor

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

@Gerrit0
Copy link
Contributor

Gerrit0 commented May 20, 2019

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.

@mray190
Copy link
Author

mray190 commented May 20, 2019

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

Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

4 participants