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

Improve documentation of the cross function #214

Open
1 of 3 tasks
wetneb opened this issue Apr 13, 2023 · 3 comments
Open
1 of 3 tasks

Improve documentation of the cross function #214

wetneb opened this issue Apr 13, 2023 · 3 comments

Comments

@wetneb
Copy link
Member

wetneb commented Apr 13, 2023

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
@antoine2711
Copy link
Member

  • Show that the result of cross() is actually an array and that the selection of one row can be done at multiple level (Owen's explanation).
  • Show an example with the join() function to get the data of many rows at the same time (Tom's suggestion).
  • Mention that cross() can access data INSIDE the current project.

I think these 3 points could also be added.

Regards,
Antoine

@wetneb
Copy link
Member Author

wetneb commented Apr 29, 2023

Your third point seems to be redundant with my second point ^^. Deduplication is a hard problem!

@antoine2711
Copy link
Member

Your third point seems to be redundant with my second point ^^. Deduplication is a hard problem!

@wetneb : there is an overlap, but my 3rd point would be a single line in the doc that would stress that cross() can be used to do self join on the current project. It's just to explicitly state what could be deducted from previous information about the function.

For me, your 2nd point is really about the fats that ANY project can be an accessible indexed based Array for cross() (i.e. that with just the project name and the row number, you can extract any rows from any project).

I think those are 2 differents concepts that need to be explicitely said.

Regards, A.

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