You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@arrow.apache.org by qu...@apache.org on 2023/06/07 03:56:53 UTC

[arrow-julia] branch jq-fix-docs created (now 6608d2f)

This is an automated email from the ASF dual-hosted git repository.

quinnj pushed a change to branch jq-fix-docs
in repository https://gitbox.apache.org/repos/asf/arrow-julia.git


      at 6608d2f  Fix various links/urls for apache/arrow-julia

This branch includes the following new commits:

     new 6608d2f  Fix various links/urls for apache/arrow-julia

The 1 revisions listed above as "new" are entirely new to this
repository and will be described in separate emails.  The revisions
listed as "add" were already present in the repository and have only
been added to this reference.



[arrow-julia] 01/01: Fix various links/urls for apache/arrow-julia

Posted by qu...@apache.org.
This is an automated email from the ASF dual-hosted git repository.

quinnj pushed a commit to branch jq-fix-docs
in repository https://gitbox.apache.org/repos/asf/arrow-julia.git

commit 6608d2ff53ccaa8e3120a334a9cf460f3c8a8d16
Author: Jacob Quinn <qu...@gmail.com>
AuthorDate: Tue Jun 6 21:56:17 2023 -0600

    Fix various links/urls for apache/arrow-julia
    
    Should fix #416.
---
 README.md          | 10 ++--------
 docs/make.jl       |  6 +++---
 docs/src/manual.md |  4 ++--
 src/utils.jl       |  2 +-
 4 files changed, 8 insertions(+), 14 deletions(-)

diff --git a/README.md b/README.md
index 8c7161a..4be1bfb 100644
--- a/README.md
+++ b/README.md
@@ -20,8 +20,8 @@
 # Arrow
 
 [![docs](https://img.shields.io/badge/docs-latest-blue&logo=julia)](https://arrow.juliadata.org/dev/)
-[![CI](https://github.com/JuliaData/Arrow.jl/workflows/CI/badge.svg)](https://github.com/JuliaData/Arrow.jl/actions?query=workflow%3ACI)
-[![codecov](https://codecov.io/gh/JuliaData/Arrow.jl/branch/master/graph/badge.svg)](https://codecov.io/gh/JuliaData/Arrow.jl)
+[![CI](https://github.com/apache/arrow-julia/workflows/CI/badge.svg)](https://github.com/apache/arrow-julia/actions?query=workflow%3ACI)
+[![codecov](https://app.codecov.io/gh/apache/arrow-julia/branch/master/graph/badge.svg)](https://app.codecov.io/gh/apache/arrow-julia)
 
 [![deps](https://juliahub.com/docs/Arrow/deps.svg)](https://juliahub.com/ui/Packages/Arrow/QnF3w?t=2)
 [![version](https://juliahub.com/docs/Arrow/version.svg)](https://juliahub.com/ui/Packages/Arrow/QnF3w)
@@ -40,12 +40,6 @@ The package can be installed by typing in the following in a Julia REPL:
 julia> using Pkg; Pkg.add("Arrow")
 ```
 
-or to use the official-apache code that follows the official apache release process, you can do:
-
-```julia
-julia> using Pkg; Pkg.add(url="https://github.com/apache/arrow", subdir="julia/Arrow.jl")
-```
-
 ## Local Development
 
 When developing on Arrow.jl it is recommended that you run the following to ensure that any
diff --git a/docs/make.jl b/docs/make.jl
index 56ef8b9..25b298e 100644
--- a/docs/make.jl
+++ b/docs/make.jl
@@ -21,11 +21,11 @@ using Arrow
 
 makedocs(;
     modules=[Arrow],
-    repo="https://github.com/JuliaData/Arrow.jl/blob/{commit}{path}#L{line}",
+    repo="https://github.com/apache/arrow-julia/blob/{commit}{path}#L{line}",
     sitename="Arrow.jl",
     format=Documenter.HTML(;
         prettyurls=get(ENV, "CI", "false") == "true",
-        canonical="https://JuliaData.github.io/Arrow.jl",
+        canonical="https://arrow.juliadata.org/",
         assets=String[],
     ),
     pages = [
@@ -36,6 +36,6 @@ makedocs(;
 )
 
 deploydocs(;
-    repo="github.com/JuliaData/Arrow.jl",
+    repo="github.com/apache/arrow-julia",
     devbranch = "main"
 )
diff --git a/docs/src/manual.md b/docs/src/manual.md
index 3cfd6e6..ea36879 100644
--- a/docs/src/manual.md
+++ b/docs/src/manual.md
@@ -23,7 +23,7 @@ The goal of this documentation is to provide a brief introduction to the arrow d
 
 The best place to learn about the Apache arrow project is [the website itself](https://arrow.apache.org/), specifically the data format [specification](https://arrow.apache.org/docs/format/Columnar.html). Put briefly, the arrow project provides a formal speficiation for how columnar, "table" data can be laid out efficiently in memory to standardize and maximize the ability to share data across languages/platforms. In the current [apache/arrow GitHub repository](https://github.com/apache/ [...]
 
-The [Arrow.jl](https://github.com/JuliaData/Arrow.jl) Julia package is another implementation, allowing the ability to both read and write data in the arrow format. As a data format, arrow specifies an exact memory layout to be used for columnar table data, and as such, "reading" involves custom Julia objects ([`Arrow.Table`](@ref) and [`Arrow.Stream`](@ref)), which read the *metadata* of an "arrow memory blob", then *wrap* the array data contained therein, having learned the type and si [...]
+The [Arrow.jl](https://github.com/apache/arrow-julia) Julia package is another implementation, allowing the ability to both read and write data in the arrow format. As a data format, arrow specifies an exact memory layout to be used for columnar table data, and as such, "reading" involves custom Julia objects ([`Arrow.Table`](@ref) and [`Arrow.Stream`](@ref)), which read the *metadata* of an "arrow memory blob", then *wrap* the array data contained therein, having learned the type and si [...]
 
 ## Support for generic path-like types
 
@@ -182,7 +182,7 @@ Again, let's break down what's going on here:
   * Now in `JuliaType`, note we're using the 3-argument overload; we want the `NamedTuple` type that is the native arrow type our `Interval` is being serialized as; we use this to retrieve the 1st type parameter for our `Interval`, which is simply the type of the two `first` and `last` fields. Then we use the 3rd argument, which is whatever string we returned from `arrowmetadata`. We call `L, R = split(meta, ".")` to parse the two type parameters (in this case `Closed` and `Unbounded`),  [...]
   * The one final wrinkle is in our `fromarrow` method; `Interval`s that are `Unbounded`, actually take `nothing` as the 2nd argument. So letting the default `fromarrow` definition call `Interval{T, L, R}(first, last)`, where `first` and `last` are both integers isn't going to work. Instead, we check if the `R` type parameter is `Unbounded` and if so, pass `nothing` as the 2nd arg, otherwise we can pass `last`.
 
-This stuff can definitely make your eyes glaze over if you stare at it long enough. As always, don't hesitate to reach out for quick questions on the [#data](https://julialang.slack.com/messages/data/) slack channel, or [open a new issue](https://github.com/JuliaData/Arrow.jl/issues/new) detailing what you're trying to do.
+This stuff can definitely make your eyes glaze over if you stare at it long enough. As always, don't hesitate to reach out for quick questions on the [#data](https://julialang.slack.com/messages/data/) slack channel, or [open a new issue](https://github.com/apache/arrow-julia/issues/new) detailing what you're trying to do.
 
 ### `Arrow.Stream`
 
diff --git a/src/utils.jl b/src/utils.jl
index 2fe31e9..f7fb23b 100644
--- a/src/utils.jl
+++ b/src/utils.jl
@@ -126,7 +126,7 @@ end
 
 toidict(x::Base.ImmutableDict) = x
 
-# ref https://github.com/JuliaData/Arrow.jl/pull/238#issuecomment-919415809
+# ref https://github.com/apache/arrow-julia/pull/238#issuecomment-919415809
 function toidict(pairs)
     isempty(pairs) && return Base.ImmutableDict{String, String}()
     dict = Base.ImmutableDict(first(pairs))