-
Notifications
You must be signed in to change notification settings - Fork 36
Add more expansive #db.f cursor documentation
#573
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
base: main
Are you sure you want to change the base?
Conversation
First draft of db cursor refinement. Expect this commit to VANISH in the future.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Looks great for a first draft! Minus two things I've caught in this current PR I think it could just go in
|
|
||
| ### Cursor Handles | ||
|
|
||
| ((%FTODO: Write something that people who have never used a file descriptor in their life can understand.%)) |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
For a first version of this page, this TODO (and other TODOs) can be pulled if you're interested in getting this merged before completing this part
|
|
||
| ## Cursor State | ||
|
|
||
| This function closes the cursor. If this is undesirable, try [count_and_keep_open](./count_and_keep_open). |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This page does not exist yet
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
There's a few missing pages:
count_and_keep_open(which you mentioned)distinct_and_keep_openeach(_and_close)each_and_keep_opensort
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Problem
The documentation for
#db.f's cursors is:limit+countinteractions)Context
This is a first draft.