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 direct linking to implicit functions (and expose them) #10

Closed
rexagod opened this issue Aug 1, 2019 · 2 comments
Closed

Add direct linking to implicit functions (and expose them) #10

rexagod opened this issue Aug 1, 2019 · 2 comments

Comments

@rexagod
Copy link
Member

rexagod commented Aug 1, 2019

The findMatchedPoints function doesn't take any values explicity, those are served to it owing to the findPoints method.

Hm, why doesn't it accept two points parameters, between which it finds matches? Wouldn't that make more sense to a user? Like, it would take two points collections as inputs, and output those which are matched between? If this would take extra changes, let's do that in a follow-up PR. Can you open an issue and copy these notes in? Thanks!

The function, however, depends specifically on args.browser that's initialized all the way at the top. Do you want me to highlight this?

Yes, that doesn't seem so clear to me so it may need explaining.

So, Below is a summary of each component of the orbify instance doesn't clearly spell out that these are parameters that can be submitted in the constructor. I think it's very important to literally show verbatim how to use each of the constructors, as in this example:

image

That'll make it much easier for people to start using this library, or to use it in unexpected ways!

Thank you, @rexagod -- much appreciated!

Originally posted by @jywarren in #6

@rexagod rexagod changed the title > The findMatchedPoints function doesn't take any values explicity, those are served to it owing to the findPoints method. Add direct linking to implicit functions Aug 1, 2019
@rexagod rexagod changed the title Add direct linking to implicit functions Add direct linking to implicit functions (and expose them) Aug 1, 2019
@jywarren jywarren mentioned this issue Aug 3, 2019
@jywarren
Copy link
Member

Looks great, thanks!

@rexagod
Copy link
Member Author

rexagod commented Aug 19, 2019

Closed since query api was exposed allowing users to run these functions differently.

https://github.com/publiclab/matcher-core/blob/main/README.md#arguments

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