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.

Sign up for GitHub

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

Jump to bottom

Update Documentation #36

Closed
10 tasks done
pgarciacamou opened this issue Apr 30, 2017 · 1 comment
Closed
10 tasks done

Update Documentation #36

pgarciacamou opened this issue Apr 30, 2017 · 1 comment
Assignees
@pgarciacamou
Labels
enhancement vPATCH

Comments

@pgarciacamou
Copy link
Owner

pgarciacamou commented Apr 30, 2017 •
edited
Loading

  • Add available patterns for people to see beforehand, add https://github.com/pgarciacamou/go-patterns/blob/master/src/go-patterns.js#L13-L21 to the README file.
  • Add comment to options.constructor.apply(this, args); => // last 1% of inheritance == super(args);
  • Add Wiki
  • Move background and when to use in README.md to wiki
  • Remove docs from npmjs.com to avoid having to release a patch version, (just add a minimum example and point to wiki as de docs).
  • Memento pattern using a verbose minimal example.
  • a lot of patterns are using method definitions notation in specs when it is not supposed to be defined like that.
  • use method definition notations for public and static method across the documentation and specs.
  • move "develop" section in readme to a "DEVELOP.md" file
  • add pattern API to docs, for example a list of methods, property and what they do and what they are for.
@pgarciacamou pgarciacamou self-assigned this Apr 30, 2017
@pgarciacamou pgarciacamou changed the title Add available patterns to documentation Update Documentation Apr 30, 2017
@pgarciacamou
Copy link
Owner Author

updates will be made in #41

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@pgarciacamou pgarciacamou

Labels
enhancement vPATCH
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@pgarciacamou