Add a description of the scopeQuery method

[hodbadger]

Fixes #885

Make sure these boxes are checked before your pull request (PR) is ready to be reviewed and merged. Thanks!

• tests pass -- look for a green checkbox ✔️ a few minutes after opening your PR -- or run tests locally with npm test
• code is in uniquely-named feature branch and has no merge conflicts
• PR is descriptively titled
• ask @publiclab/is-reviewers for help, in a comment below

We're happy to help you get this ready -- don't be afraid to ask for help, and don't be discouraged if your tests fail at first!

If tests do fail, click on the red X to learn why by reading the logs.

Please be sure you've reviewed our contribution guidelines at https://publiclab.org/contributing-to-public-lab-software

Thanks!

[welcome]

Thanks for opening this pull request!
There may be some errors, but don't worry! We're here to help! 👍🎉😄

[harshkhandeparkar]

Nicely done but requires a few changes.

[harshkhandeparkar]

Please link to the issue in the pr body like I just did by editing your pr.

Also please have a look at #833

[hodbadger]

Sorry to bother you but I have some questions.
I have to create a new pull request with the required changes, right?
Also, I've already taken a look at #833, but what exactly should I pay attention to?
I'm also not sure what you mean by linking the issue in the pr body - where should I put the link?

[harshkhandeparkar]

Ok, answers:

1. You don't have to open a new pr, you can commit to the same branch and the commits will be visible here.
2. Completion Of $step helper method #833 mentions that all 3 PRs will be merged together. So, this pr will not be merged instantly, you will have to wait for the 3rd pr. You can solve other issues, no problem. There are some other documentation issues but they are not first timers only issues but you are no longer a first timer.
3. The pr template has "Fixes #[add issue number here.]". This can be replaced with for e.g. Fixes #220 if the issue you are solving is the 220th issue. When the pr is merged issue number 220 will be automatically closed. This also holds true if you use keywords like fix, resolve, resolves, closes etc. The issue will be closed upon merge. So, next time you can add the issue number to the pr (if your pr fixes an issue). This time I added the issue number to demonstrate. Github automatically changes #xxx where xxx is a number to a link to issue number xxx. You can also add the full browser link to the issue and github will also change that to #xxx as a link.

[hodbadger]

Thanks a lot for the answers!
I've committed the changes and hope it's OK now.
I'll be glad to help with other issues connected to documentation.

[harshkhandeparkar]

Great! But a few more changes are required and the code has a small syntax error.

[harshkhandeparkar]

Great!! Thanks for your efforts and welcome to the publiclab coding community

[hodbadger]

Thanks for your patience and for helping me through the issue. As I said, I'd be glad to help with other documentation issues (the only thing I can help with since I'm not a developer).

[harshkhandeparkar]

You can check other issues with the documentation label. Thanks!

[welcome]

Congrats on merging your first pull request! 🙌🎉⚡️
Your code will be published to https://beta.sequencer.publiclab.org in a day or two.
In the meantime, can you tell us your Twitter handle so we can thank you properly?
Now that you've completed this, you can help someone else take their first step!
See: Public Lab's coding community!

[jywarren]

Thank you so much!!!

[harshkhandeparkar]

@jywarren the scopeQuery method which is documented is non existent 😂