Skip to content

ARROW-4089: [Plasma] The tutorial is wrong regarding the parameter type of PlasmaClient.Create #3235

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.

Sign up for GitHub

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

Closed
sarutak wants to merge 1 commit into from
Closed

ARROW-4089: [Plasma] The tutorial is wrong regarding the parameter type of PlasmaClient.Create #3235

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions cpp/apidoc/tutorials/plasma.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -182,7 +182,7 @@ was written by the `Create` command.
int64_t data_size = 100;
Copy link
Copy Markdown
Member

@wesm wesm Dec 20, 2018

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We should perhaps turn this into an example we compile and include it in the Sphinx documentation

// The address of the buffer allocated by the Plasma store will be written at
// this address.
uint8_t* data;
std::shared_ptr<Buffer> data;
// Create a Plasma object by specifying its ID and size.
ARROW_CHECK_OK(client.Create(object_id, data_size, NULL, 0, &data));
```
Expand All @@ -194,7 +194,7 @@ metadata (as raw bytes) and the fourth argument is the size of the metadata.
// Create a Plasma object with metadata.
int64_t data_size = 100;
std::string metadata = "{'author': 'john'}";
uint8_t* data;
std::shared_ptr<Buffer> data;
client.Create(object_id, data_size, (uint8_t*) metadata.data(), metadata.size(), &data);
```

Expand Down