Skip to content

Conversation

duaneatat
Copy link
Contributor

@duaneatat duaneatat commented Aug 25, 2022

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.

@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
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
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