Skip to content
Permalink
Browse files
Fix docs
  • Loading branch information
quinnj committed Oct 3, 2020
1 parent f628b8f commit 5b73f85de0b1ff595d9b6a81889ff74bbe7a0968
Show file tree
Hide file tree
Showing 2 changed files with 4 additions and 4 deletions.
@@ -46,7 +46,7 @@ Third-party data formats:
Read an arrow formatted table, from:
* `io`, bytes will be read all at once via `read(io)`
* `file`, bytes will be read via `Mmap.mmap(file)`
# `bytes`, a byte vector directly, optionally allowing specifying the starting byte position `pos` and `len`
* `bytes`, a byte vector directly, optionally allowing specifying the starting byte position `pos` and `len`

Returns a `Arrow.Table` object that allows column access via `table.col1`, `table[:col1]`, or `table[1]`.

@@ -81,7 +81,7 @@ tbl = Arrow.Table(resp.body)
Start reading an arrow formatted table, from:
* `io`, bytes will be read all at once via `read(io)`
* `file`, bytes will be read via `Mmap.mmap(file)`
# `bytes`, a byte vector directly, optionally allowing specifying the starting byte position `pos` and `len`
* `bytes`, a byte vector directly, optionally allowing specifying the starting byte position `pos` and `len`

Reads the initial schema message from the arrow stream/file, then returns an `Arrow.Stream` object
which will iterate over record batch messages, producing an `Arrow.Table` on each iteration.
@@ -11,7 +11,7 @@ end
Start reading an arrow formatted table, from:
* `io`, bytes will be read all at once via `read(io)`
* `file`, bytes will be read via `Mmap.mmap(file)`
# `bytes`, a byte vector directly, optionally allowing specifying the starting byte position `pos` and `len`
* `bytes`, a byte vector directly, optionally allowing specifying the starting byte position `pos` and `len`
Reads the initial schema message from the arrow stream/file, then returns an `Arrow.Stream` object
which will iterate over record batch messages, producing an `Arrow.Table` on each iteration.
@@ -119,7 +119,7 @@ end
Read an arrow formatted table, from:
* `io`, bytes will be read all at once via `read(io)`
* `file`, bytes will be read via `Mmap.mmap(file)`
# `bytes`, a byte vector directly, optionally allowing specifying the starting byte position `pos` and `len`
* `bytes`, a byte vector directly, optionally allowing specifying the starting byte position `pos` and `len`
Returns a `Arrow.Table` object that allows column access via `table.col1`, `table[:col1]`, or `table[1]`.

2 comments on commit 5b73f85

@quinnj
Copy link
Member Author

@quinnj quinnj commented on 5b73f85 Oct 3, 2020

Choose a reason for hiding this comment

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

@JuliaRegistrator register()

@JuliaRegistrator
Copy link

@JuliaRegistrator JuliaRegistrator commented on 5b73f85 Oct 3, 2020

Choose a reason for hiding this comment

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

Registration pull request created: JuliaRegistries/General/22370

After the above pull request is merged, it is recommended that a tag is created on this repository for the registered package version.

This will be done automatically if the Julia TagBot GitHub Action is installed, or can be done manually through the github interface, or via:

git tag -a v0.3.0 -m "<description of version>" 5b73f85de0b1ff595d9b6a81889ff74bbe7a0968
git push origin v0.3.0

Please sign in to comment.