JSDoc for the sw-broadcast-cache-update project. #60
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.
R: @addyosmani @gauntface
Here's an initial batch of JSDocs, for the
sw-broadcast-cache-update
project.You can take a look at them rendered at https://github.com/GoogleChrome/sw-helpers/blob/jsdoc/projects/sw-broadcast-cache-update/README.md
It unfortunately feels like a pretty noisy page, and probably isn't the best format to share with developers, but that's just one possible rendering of the underlying JSDocs (via the
documentation
library). I think @gauntface has alternative plans for how they'll get rendered in the future.The one sore point that I ran into was that
documentation
forces the name$0
for the anonymous destructed object we're using as parameters in all the functions. That$0
could be confusing, but it's not currently possible to override. Maybe we should consider post-processing the generated docs to convert$0
toparameters
or something?