Primary objective: Add jsdoc-compatible docstrings and doc-build task #10
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
…e extensions to .JS (no react utilized at this time); added documentation artifacts ('public/') to gitignore; added jsdoc configuration file; incremented semver; added docs task to package scripts; added jsdoc and foodoc to development dependencies; expanded readme documentation to include package scripts; updated webpack configuration to reflect new/simplified file extensions
Open
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This includes the following features from the single commit involved:
Added jsdoc-compatible docstrings to source module
Renamed lib source extensions to .JS (since no React is utilized at this time, this greatly simplifies cross-package compatibility)
Added documentation artifacts ('public/') to gitignore
Added jsdoc configuration file
Incremented semver (UPDATE: not included with commit, but strongly recommended)
Added docs task to package scripts
Added jsdoc and foodoc to development dependencies
Expanded readme documentation to include package scripts
Updated webpack configuration to reflect new/simplified file extensions