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.

Sign up for GitHub

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

Jump to bottom

[types-2.0] Complete JSDoc Comments D3 version 4 Module Definitions #11366

Closed
24 of 34 tasks
tomwanzek opened this issue Sep 21, 2016 · 11 comments
Closed
24 of 34 tasks

[types-2.0] Complete JSDoc Comments D3 version 4 Module Definitions #11366

tomwanzek opened this issue Sep 21, 2016 · 11 comments
Labels
@types

Comments

@tomwanzek
Copy link
Contributor

tomwanzek commented Sep 21, 2016 •
edited
Loading

This issue is an enhancement request/tracking item pertaining to the TypeScript 2.0 definitions for D3 version 4 modules in the DefinitelyTyped/types-2.0 Branch.

The enhancement sought is a completion of JSDoc comments on a module-by-module basis for improved IDE support.

Specifically, this issue is spun off from the original Definition Request #9936 .

For tracking purposes, below is a checklist of the definitions, to be reviewed and updated as necessary:

  • d3-array
  • d3-axis
  • d3-brush
  • d3-chord
  • d3-collection
  • d3-color
  • d3-contour
  • d3-dispatch
  • d3-drag
  • d3-dsv
  • d3-ease
  • d3-force
  • d3-format
  • d3-geo
  • d3-hierarchy
  • d3-hsv
  • d3-interpolate
  • d3-path
  • d3-polygon
  • d3-quadtree
  • d3-queue
  • d3-random
  • d3-request
  • d3-sankey
  • d3-scale
  • d3-selection
  • d3-selection-multi
  • d3-shape
  • d3-time
  • d3-time-format
  • d3-timer
  • d3-transition
  • d3-voronoi
  • d3-zoom

PRs to support the completion of this effort are welcome!!! Please ensure the definition authors listed in the header comment are advised of proposed changes before a merge.

cc @gustavderdrache @Ledragon

Edit: Status Update as of 2016-11-07
Edit: Status Update as of 2016-12-07
Edit: Status Update as of 2017-05-1 (adds d3-sankey and d3-contour for completeness)
Edit Status Update as of 2017-10-12
Edit Status Update as of 2017-11-04
@tomwanzek tomwanzek mentioned this issue Sep 21, 2016
Closed
@tomwanzek
Copy link
Contributor Author

@vvakame could you kindly attach a help wanted label to this issue. Thx!

@tomwanzek
Copy link
Contributor Author

d3-select is ready with JSDoc comments. PR to follow shortly.

This was referenced Sep 26, 2016
Merged
Merged
Merged
@tomwanzek
Copy link
Contributor Author

Beyond the referenced PRs, I have local udpate for:

  • d3-format
  • d3-timer
  • d3-random

@vvakame vvakame added the @types label Sep 28, 2016
@tomwanzek tomwanzek mentioned this issue Sep 28, 2016
Merged
@tomwanzek
Copy link
Contributor Author

@RyanCavanaugh @andy-ms can either of you please merge the following PRs, they are aging quickly:

If there is any development related reason, why you do not want to merge, triggering types-publisher right now, a simple heads-up with ETA would be appreciated in the meantime.

Thanks!

@tomwanzek
Copy link
Contributor Author

tomwanzek commented Oct 3, 2016 •
edited
Loading

Updated the status of definitions complete with JSDoc comments.

In a short follow-up to the d3-transition definition JSDoc comments, the Selection interface augmentation needs to be updated with the same JSDoc comment as Selection in d3-selection.

This is necessary, as the augmentation "covers" the JSDoc comments from the original Selection definition, when d3-transition is loaded (tested in VSCode).

EDIT: Need to do the same for d3-selection-multi.

This was referenced Oct 28, 2016
Closed
Merged
@tomwanzek
Copy link
Contributor Author

d3-voronoi submitted with JSDoc comments starting from version 1.1.0

This was referenced Oct 29, 2016
Closed
Merged
@tomwanzek
Copy link
Contributor Author

d3-geo submitted with JSDoc comments starting from version 1.3.1

@tomwanzek tomwanzek mentioned this issue Nov 8, 2016
Closed
10 tasks
@tomwanzek tomwanzek mentioned this issue Nov 26, 2016
Merged
11 tasks
@tomwanzek
Copy link
Contributor Author

tomwanzek commented Nov 26, 2016 •
edited
Loading

Further PR started, covers:

  • d3-chord
  • d3-path
  • d3-time
  • d3-scale
  • d3-shape

EDIT: Added additional modules to PR #12923 .(2016-11-27)
EDIT: Added d3-shape PR #12923 .(2016-11-29)

This was referenced Dec 30, 2016
Closed
Merged
@tomwanzek
Copy link
Contributor Author

d3-ease submitted as PR.

@tomwanzek
Copy link
Contributor Author

d3-ease complete.

@tomwanzek tomwanzek mentioned this issue May 2, 2017
Merged
9 tasks
@tomwanzek tomwanzek mentioned this issue Oct 11, 2017
Merged
8 tasks
weswigham pushed a commit that referenced this issue Oct 11, 2017
@tomwanzek @weswigham
[d3-time-format] (#20483)
f25fd1c 
* [CHORE] Update version number. Closes #20479
* [CHORE] Complete JSDoc comments. Related to #11366
* [CHORE] Validate for strictNullChecks. Related to  #11365
@tomwanzek tomwanzek mentioned this issue Nov 1, 2017
Merged
8 tasks
@tomwanzek
Copy link
Contributor Author

Closed in favor of consolidated tracking issue #23611.

@tomwanzek tomwanzek reopened this Feb 13, 2018
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
@types
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
2 participants
@vvakame @tomwanzek