Meteor-Community-Packages / Meteor-Community-Packages/ground-db

Ground.methodResume is a little bit confusingly described

Open
#138 3 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

enhancement help wanted
Dominant language
JavaScript
Stars
569
Forks
77
PR merge metrics
No merged PRs in 30d

Description

I had some hard time understanding how `Ground.methodResume` works. Here are the issues I've had:
1. It starts in the **Concept** paragraph, which states `Ground.resumeMethods` instead of `methodResume` (slight detail, but adds on to the confusion)
2. I don't think the provided example really helps, it didn't help me at all:

```
// This is how grounddb uses this internally
Ground.methodResume([
'/' + self.name + '/insert',
'/' + self.name + '/remove',
'/' + self.name + '/update'
], self.connection);
```

What I got out of this and how I'm using it now could be summarised in the following sentence:

> When you to have your server-methods automatically run / resumed on the server, after a connection is established you need to tell this to Ground via `Ground.methodResume`. For instance:

```
Ground.methodResume('serverMethod');
Ground.methodResume(['serverMethod2', 'serverMethod3']);
```

This is also, how I'm using it now, and it seems to work fine. If that's the correct way, maybe the documentation can be adapted to be easier to understand?

Thx

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by locating the documentation for Ground.methodResume and its Concept paragraph. Correct the reference to Ground.resumeMethods, clarify when methodResume is used, and review the examples for single and multiple server methods. Done means the documented behavior matches the usage described in the issue.

Written by the indexing model from the issue text.

Assessment

Tech stack
javascript
Domain
documentation
Issue type
Documentation
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
55/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.