OpenRefine / OpenRefine/openrefine.org

Improve documentation of the cross function

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

Nobody has claimed this yet.

Dominant language
TypeScript
Stars
161
Forks
142
Avg merge
6h 10m
Merged PRs (30d)
9

Description

The documentation of the cross function should be reviewed and improved:

  • make sure the example expressions are correct (currently cell.cross("People","Name").cells["Address"].value[0], perhaps should be cell.cross("People","Name").cells["Address"][0].value instead?)
  • document the use of the cross function to access any cell of the current project (see this comment)
  • maybe more of the content from the wiki could be integrated in the docs directly

Contributor guide

No contributing guide indexed for this repository

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 with the linked GREL cross-function documentation and verify the example expressions against the function behavior. Read the referenced comment in issue 3305 and compare the wiki's “Combining datasets” recipe. Done means corrected examples, documented access to cells in the current project, and any useful wiki content integrated into the documentation.

Written by the indexing model from the issue text.

Assessment

Domain
documentation
Issue type
Documentation
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
42/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.