Skip to content

Script to keep README in sync with JSDoc #1034

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
Merged
merged 60 commits into from
Aug 26, 2022
Merged

Script to keep README in sync with JSDoc #1034

merged 60 commits into from
Aug 26, 2022

Conversation

duaneatat
Copy link
Contributor

@duaneatat duaneatat commented Aug 25, 2022 •
edited
Loading

Putting this in a separate PR to make reviewing #1016 easier.

Will merge after #1016 is reviewed/merged.

Going to merge this PR into main since it has all of the changes.

Duane Millar Barlow added 30 commits July 28, 2022 11:24
Add script to inject JSDoc into README.md
5dc70d6
yarn readme:update
1d34ce2
emit declaration files to types/
d98fab4
jsdoc-to-readme - allow specifiying the title prefix
119e0ef
use full urls for readme links
cd18fa3
JSDoc for scales
9668a22
jsdoc legend
8a60c10
fix link
1a8b1b3
jsdoc-to-readme - indicate in title when a param uses dot-dot-dot not…
38dd8ec 
…ation
jsdoc marks
8ac36fd
fix link
658871a
jsdoc area
42f2e61
jsdoc areaX
9a43100
jsdoc areaY
0cc56ff
jsdoc arrow
021d1f8
jsdoc barX
1c3137e
jsdoc barY
6a8032e
jsdoc boxX, boxY
2814bb0
jsdoc cell, cellX, cellY
57d18b9
jsdoc delaunayLink, delaunayMesh
4904ab3
jsdoc hull, voronoi, voronoiMesh
2d47b19
jsdoc density
efa31a7
jsdoc dot, dotX, dotY
f1c9468
jsdoc circle, hexagon
1b2bae0
jsdoc hexgrid
dab682a
jsdoc image
bd10157
jsdoc linearRegressionX, linearRegressionY
4574b7b
jsdoc line, lineX, lineY
9c96d02
jsdoc link
2a075b1
jsdoc rect, rectX, rectY
9124408
@duaneatat duaneatat requested review from Fil and mbostock August 25, 2022 04:03
@duaneatat duaneatat mentioned this pull request Aug 25, 2022
Closed
@Fil
Copy link
Contributor

Fil commented Aug 25, 2022

Was this done as a manual operation or with some kind of script?

@duaneatat
Copy link
Contributor Author

Was this done as a manual operation or with some kind of script?

Both: it was done using the Rewrap vscode plugin, but did require me to go to every jsdoc block and type "Option-Q" to trigger the wrapping. So I might have missed a block, but within each block it was automated

@duaneatat duaneatat changed the base branch from duane/jsdoc-to-readme to main August 26, 2022 14:40
@duaneatat duaneatat marked this pull request as ready for review August 26, 2022 14:40
@duaneatat duaneatat changed the title Hard-wrap JSDoc comments Script to keep README in sync with JSDoc Aug 26, 2022
Fil
Fil approved these changes Aug 26, 2022
View reviewed changes
Copy link
Contributor

@Fil Fil left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Let's squash and merge this branch, to limit churn on README.md

For reference the (minimal) changes, without wrapping, can be seen at #1016

@duaneatat duaneatat merged commit 8065e59 into main Aug 26, 2022
@duaneatat duaneatat deleted the duane/jsdoc-hard-wrap branch August 26, 2022 14:44
@mbostock mbostock mentioned this pull request Oct 22, 2022
Merged
@mbostock mbostock mentioned this pull request May 12, 2023
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@Fil Fil Fil approved these changes

@mbostock mbostock Awaiting requested review from mbostock

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@duaneatat @Fil