Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update all dc.mixin docs #999

Merged
merged 3 commits into from
Sep 18, 2015

Conversation

mtraynham
Copy link
Contributor

This adds a lot of missing documentation to the baseMixin. Added default implementation examples, @see links (notably to other functions of interest & crossfilter/d3/HTML/SVG docs), and after a review of the current JSDoc implementation, updates references that returned Chart to just return dc.baseMixin. Using Chart seems a bit unnecessary, since we should just be linking back to the dc.baseMixin (plan to update the other mixin/charts with this as well).

Depending on timeframe, I may get to the other mixins/charts this week as well, so I may rename the title and the changeset will grow.

Interesting to document some of these things I didn't know existed or only work under some circumstances; guess I just don't use some of these things that often or take the functionality for granted...

@mtraynham mtraynham closed this Aug 27, 2015
@mtraynham mtraynham deleted the base_mixin_doc_updates branch August 27, 2015 14:36
@mtraynham
Copy link
Contributor Author

woops reopen.

@mtraynham mtraynham reopened this Aug 27, 2015
@mtraynham mtraynham changed the title Update baseMixin docs Update all dc.mixin docs Sep 13, 2015
@gordonwoodhull gordonwoodhull modified the milestone: v2.0 Sep 14, 2015
@gordonwoodhull
Copy link
Contributor

Thanks @mtraynham!

@gordonwoodhull gordonwoodhull merged commit 09ac529 into dc-js:master Sep 18, 2015
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants