rethinkdb / rethinkdb/docs

Docs unclear about need to call cursor.close() after cursor.toArray()

Open
#1,194 1 comment 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
CSS
Stars
118
Forks
161
PR merge metrics
No merged PRs in 30d

Description

I saw this comment when looking at the IRC logs.

Does cursor.toArray() or other driver equivalents call cursor.close()? The docs are not clear on if I should be calling cursor.close() myself after

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

Review the documentation covering cursor.toArray() and the other driver equivalents, then check how cursor.close() is described. Clarify whether callers must close cursors after materializing results, and ensure the documented lifecycle is consistent across the affected examples.

Written by the indexing model from the issue text.

Assessment

Domain
documentation
Issue type
Documentation
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.