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

New README #17

Merged
merged 7 commits into from
Oct 3, 2018
Merged

New README #17

merged 7 commits into from
Oct 3, 2018

Conversation

alissonperez
Copy link
Owner

@alissonperez alissonperez commented Jul 14, 2018

ref. #13

Description

New README with a decent documentation.

Motivation, Consideration and Context

It is now a piece of junk!

Checklist:

  • Simple example
  • Example with function
  • Example with promises
  • Detail each picker constructor (simple and xpath)

Additional:

  • Remove precommit hook.

@alissonperez alissonperez self-assigned this Jul 14, 2018
@alissonperez alissonperez force-pushed the new-docs branch 2 times, most recently from 6e53f62 to 07098e4 Compare July 14, 2018 04:26
@alissonperez alissonperez force-pushed the new-docs branch 7 times, most recently from ce24b9f to c5d4c1c Compare July 17, 2018 04:29
@alissonperez
Copy link
Owner Author

@guicheffer Please, give me a review for what I had written until now! ❤️

@alissonperez alissonperez requested a review from guicheffer July 17, 2018 04:31
@alissonperez alissonperez force-pushed the new-docs branch 3 times, most recently from 0eafcb6 to d4519e5 Compare July 17, 2018 04:37
otherInt: 10
}
}
title: 'Star Wars: Episode V - The Empire Strikes Back',

This comment was marked as resolved.

README.md Outdated
}

// Pay attention here, picker instance is with 'nextMovie' context,
// so, when we call "pick" method it knows exactally what needs to cut
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

typo exactly

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

sounds better whether needs to be cut out or not


Ok, what happend?!

First of all, we didn't ask for "previousMovie", so deepicker don't evaluate this function. In this example this don't affect performance, but thinking about an operation like access to a database to get something or call some API this can increase performance significantly. The main gain here is **we process only what client asks for**.

This comment was marked as resolved.

README.md Outdated
description: 'The galaxy is in the midst of a civil war. Spies for the Rebel Alliance have stolen plans...',
releaseYear: 1977,

// Using a function to computate otherInfo about Episode IV
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

typo compute

Here we'll resolve a function in our object and items of an array.
#### Using nested functions

But we know, unfortunatelly, real life "usually" is not so simple. Thinking about it, Deepicker is able to handle a lot of data types inside our objects, like arrays, promises, functions... etc. And with this last data type is where Deepicker really shines and show its power! =)

This comment was marked as resolved.

{ name: 'Luke Skywalker', actor: 'Mark Hamill' },
{ name: 'Han Solo', actor: 'Harrison Ford' },
{ name: 'Princess Leia Organa', actor: 'Carrie Fischer' },
{ name: 'Darth Vader', actor: 'James Earl Jones' },

This comment was marked as resolved.

README.md Outdated
- Simple implementation.
- Increases performance processing only what client asks for.
- Non-blocking processing, it handles promisses in parallel very well.
- Simple usage by clients. Just receive an `include` and `exclude` querystring and send then to Deepicker.
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

typo them

or, if you prefer `yarn`:

```bash
$ yarn add deepicker

This comment was marked as resolved.

@guicheffer
Copy link
Collaborator

so far too great @alissonperez

Please let me know (even am watchin to this) whether you have things to be reviewed 😍

@alissonperez
Copy link
Owner Author

@guicheffer Thank you very much!! Awesome!! I'll fix your points ASAP!

@alissonperez
Copy link
Owner Author

@guicheffer Done, thanks! I'll work more on this today later!

@guicheffer
Copy link
Collaborator

👀

@alissonperez alissonperez merged commit de9741a into master Oct 3, 2018
@alissonperez alissonperez deleted the new-docs branch October 3, 2018 03:15
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

Successfully merging this pull request may close these issues.

2 participants