Skip to content
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.

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

Add examples to all public methods. #139

Closed
addyosmani opened this issue Jan 13, 2017 · 2 comments
Closed

Add examples to all public methods. #139

addyosmani opened this issue Jan 13, 2017 · 2 comments

Comments

@addyosmani
Copy link
Member

Library Affected:
sw-precaching

Browser & Platform:
All browsers

Issue or Feature Request Description:
A few of our public methods currently include a code snippet, but others reference the source implementation without providing one. If a public method is meant to be used, we could try to include a usage snippet so it's clear how to use it on it's own.

@addyosmani
Copy link
Member Author

It would similarly be great if we could as much as possible make snippets complete. One example is the RevisionedCacheManager. We show examples of how to use an existing instance of RevisionedCacheManager but not how to create one or what the defaults for it are.

e.g https://github.com/GoogleChrome/sw-helpers/tree/master/packages/sw-precaching#cache-1

@gauntface gauntface changed the title sw-precaching > README > add code snippets for all public methods Add examples to all public methods. Jan 18, 2017
@gauntface
Copy link

I've collapsed this in #164

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

No branches or pull requests

2 participants