Join GitHub today
GitHub is home to over 28 million developers working together to host and review code, manage projects, and build software together.Sign up
Proposal: Show inherited and mixed-in values #4496
TLDR; Many parts of CanJS get inherited or mixed-in methods and behaviors. Lets make it easier for users to understand what is mixed in.
But this isn't super obvious. And, it is difficult to make work. It relies on some special knowledge of
The solution is to make it easy for a module to specify what is mixed in and what is inherited. Perhaps:
Idea A - just list inherited and mixed package at the top.
Here's how JavaDoc shows inheritance and what is mixed-in:
Idea B - Have an area after signatures that list everything mixed-in
Idea C - List mixed/inherited in stuff in the sidebar
Here you could click to expand what is inherited by
Ideally, the methods/symbols would replace those links.
Idea D - Buttons to expand what's mixed-in / inherited
Canjs doesn’t touch native prototypes. And, these mixins are added to types before any instance is created. There’s no performance issue.
@justinbmeyer i would love when we could get away from mixin style to some more functional style. so that all is more predictable even without documentation i like really much the longCamelCaseNamesForFunctionsThatTellPeopleExactlyWhatTheyDo but ok it has nothing to do with this issue so lets forget about that :)