Skip to content

JSDoc: Update so it actually works #369

Description

@nexushoratio

https://nexushoratio.github.io/userscripts/


Now that we have a process, use this to track the progress.

Will create config files and update test.user.js to start.

Since we are unable to run jsdoc locally (older OS), we will do the following:

  1. Create throw-away branch for module being updated
  2. Update config to cover the next module and push to branch (use git push --no-verify to avoid version checks)
  3. Incrementally address errors and push branch until module passes
  4. Incrementally improve doc coverage and push branch until happy
  5. Manually copy (NOT merge) improved module and config back to main
  6. Delete throw-away branch both locally and on GH

No immediate plan to actually publish the docs. That is likely to come later.

Originally posted by @nexushoratio in #367

Metadata

Metadata

Assignees

Labels

documentationImprovements or additions to documentationlibraryFor librarieslinkedin-toolFor the LinkedIn Tool userscript

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions