docs: improve documentation (#14)

- Simplify installation section to single line format
- Update documentation index to match README badge ordering
- Clarify ecosystem integration mentions DimensionalData instead of generic Tables
- Remove return type annotation from `get_capabilities` docstring
- Remove unused `columns` function from HAPIVariable

Author: Beforerr

README.md

@@ -1,7 +1,7 @@
 # HAPIClient
 
-[![Dev](https://img.shields.io/badge/docs-dev-blue.svg)](https://JuliaSpacePhysics.github.io/HAPIClient.jl/dev/)
 [![DOI](https://zenodo.org/badge/935193759.svg)](https://doi.org/10.5281/zenodo.15108960)
+
 [![Build Status](https://github.com/JuliaSpacePhysics/HAPIClient.jl/actions/workflows/CI.yml/badge.svg?branch=main)](https://github.com/JuliaSpacePhysics/HAPIClient.jl/actions/workflows/CI.yml?query=branch%3Amain)
 [![Aqua QA](https://raw.githubusercontent.com/JuliaTesting/Aqua.jl/master/badge.svg)](https://github.com/JuliaTesting/Aqua.jl)
 [![Coverage](https://codecov.io/gh/JuliaSpacePhysics/HAPIClient.jl/branch/main/graph/badge.svg)](https://codecov.io/gh/JuliaSpacePhysics/HAPIClient.jl)
@@ -10,12 +10,7 @@ A Julia client for the Heliophysics Application Programmer's Interface (HAPI).
 
 For information on using the package, see the [documentation](https://JuliaSpacePhysics.github.io/HAPIClient.jl/dev/). For the list of HAPI servers and datasets, see [HAPI Server Browser](https://hapi-server.org/servers/).
 
-## Installation
-
-```julia
-using Pkg
-Pkg.add("HAPIClient")
-```
+**Installation**: at the Julia REPL, run `using Pkg; Pkg.add("HAPIClient")`
 
 ## Usage Example
 
@@ -57,4 +52,8 @@ parent(var)
 times(var)
 # to retrieve the metadata
 meta(var)
-```
+```
+
+## Elsewhere
+
+- [HAPI GitHub](https://github.com/hapi-server): Official HAPI GitHub organization

docs/src/index.md

@@ -1,7 +1,8 @@
 # HAPIClient.jl
 
-[![Build Status](https://github.com/JuliaSpacePhysics/HAPIClient.jl/actions/workflows/CI.yml/badge.svg?branch=main)](https://github.com/JuliaSpacePhysics/HAPIClient.jl/actions/workflows/CI.yml?query=branch%3Amain)
 [![DOI](https://zenodo.org/badge/935193759.svg)](https://doi.org/10.5281/zenodo.15108960)
+
+[![Build Status](https://github.com/JuliaSpacePhysics/HAPIClient.jl/actions/workflows/CI.yml/badge.svg?branch=main)](https://github.com/JuliaSpacePhysics/HAPIClient.jl/actions/workflows/CI.yml?query=branch%3Amain)
 [![Aqua QA](https://raw.githubusercontent.com/JuliaTesting/Aqua.jl/master/badge.svg)](https://github.com/JuliaTesting/Aqua.jl)
 [![Coverage](https://codecov.io/gh/JuliaSpacePhysics/HAPIClient.jl/branch/main/graph/badge.svg)](https://codecov.io/gh/JuliaSpacePhysics/HAPIClient.jl)
 
@@ -13,7 +14,7 @@ HAPIClient.jl makes it easy to access heliophysics data from HAPI-compliant serv
 - Browsing catalogs of datasets
 - Retrieving parameter information
 - Downloading time series data
-- Integration with Julia's ecosystem (Dates, Tables, Unitful)
+- Integration with Julia's ecosystem (Unitful, [DimensionalData](https://github.com/rafaqz/DimensionalData.jl))
 
 ## Installation
 

src/server.jl

@@ -33,7 +33,7 @@ format(s::Server) = getfield(s, :format)
 format(s) = DEFAULT_FORMAT
 
 """
-    get_capabilities(server) -> Dict
+    get_capabilities(server)
 
 Get server capabilities.
 """

src/types.jl

@@ -114,7 +114,6 @@ end
 
 HAPIVariable(d::AbstractDict, meta, i::Integer) = HAPIVariable(d, i)
 
-columns(var::HAPIVariable) = meta(var)["columns"]
 colsize(var::HAPIVariable) = colsize(meta(var))
 
 # when units have more than one value, return an array

test/data.jl

@@ -3,8 +3,8 @@
 @testitem "get_data" begin
     id = "CDAWeb/AC_H0_MFI/Magnitude,BGSEc"
     tmin = "2001-01-01T05"
-    tmax =  "2001-01-01T06"
-    data = get_data(id, [tmin, tmax]; verbose=1)
+    tmax = "2001-01-01T06"
+    data = get_data(id, [tmin, tmax]; verbose = 1)
     @test data.Magnitude == data[1]
     @test length(data) == 2
     @test length(times(data)) == 225
@@ -104,4 +104,5 @@ end
     tmax = "2001-01-01T06:00:00"
 
     @test_nowarn hapi(server, dataset, parameters, tmin, tmax)
+    @time hapi(server, dataset, parameters, tmin, tmax)
 end

test/metadata.jl

@@ -2,6 +2,8 @@
     servers = hapi()
     @test "https://cdaweb.gsfc.nasa.gov/hapi" in servers
     @test length(servers) > 0
+
+    @test HAPIClient.get_capabilities(CDAWeb)["status"]["code"] == 1200
 end
 
 @testitem "Catalog" begin