Skip to content

Commit e625b19

Browse files
committed
Fix repo naming (HivePaths does not pass general-registry's naming check.
1 parent 2ed5dbd commit e625b19

File tree

9 files changed

+37
-37
lines changed

9 files changed

+37
-37
lines changed

.github/workflows/CI.yml

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ on:
77
push:
88
branches:
99
- main
10-
tags: ['*']
10+
tags: ["*"]
1111
pull_request:
1212
workflow_dispatch:
1313
concurrency:
@@ -27,9 +27,9 @@ jobs:
2727
fail-fast: false
2828
matrix:
2929
version:
30-
- '1.10'
31-
- '1.12'
32-
- 'pre'
30+
- "1.10"
31+
- "1.12"
32+
- "pre"
3333
os:
3434
- ubuntu-latest
3535
arch:
@@ -66,7 +66,7 @@ jobs:
6666
- uses: actions/checkout@v6
6767
- uses: julia-actions/setup-julia@v2
6868
with:
69-
version: '1'
69+
version: "1"
7070
- uses: julia-actions/cache@v2
7171
- uses: okatsn/add-registry@v2
7272
- name: Configure doc environment
@@ -84,6 +84,6 @@ jobs:
8484
shell: julia --project=docs --color=yes {0}
8585
run: |
8686
using Documenter: DocMeta, doctest
87-
using HivePaths
88-
DocMeta.setdocmeta!(HivePaths, :DocTestSetup, :(using HivePaths); recursive=true)
89-
doctest(HivePaths)
87+
using HiveStructurePaths
88+
DocMeta.setdocmeta!(HiveStructurePaths, :DocTestSetup, :(using HiveStructurePaths); recursive=true)
89+
doctest(HiveStructurePaths)

Project.toml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
name = "HivePaths"
1+
name = "HiveStructurePaths"
22
uuid = "67cf009d-4aa4-48c9-a112-d5138c970da1"
33
authors = ["okatsn <okatsn@gmail.com> and contributors"]
44
version = "0.1.0"

README.md

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,20 +1,20 @@
1-
# HivePaths
1+
# HiveStructurePaths
22

3-
[![Stable](https://img.shields.io/badge/docs-stable-blue.svg)](https://okatsn.github.io/HivePaths.jl/stable/)
4-
[![Dev](https://img.shields.io/badge/docs-dev-blue.svg)](https://okatsn.github.io/HivePaths.jl/dev/)
5-
[![Build Status](https://github.com/okatsn/HivePaths.jl/actions/workflows/CI.yml/badge.svg?branch=main)](https://github.com/okatsn/HivePaths.jl/actions/workflows/CI.yml?query=branch%3Amain)
6-
[![Coverage](https://codecov.io/gh/okatsn/HivePaths.jl/branch/main/graph/badge.svg)](https://codecov.io/gh/okatsn/HivePaths.jl)
3+
[![Stable](https://img.shields.io/badge/docs-stable-blue.svg)](https://okatsn.github.io/HiveStructurePaths.jl/stable/)
4+
[![Dev](https://img.shields.io/badge/docs-dev-blue.svg)](https://okatsn.github.io/HiveStructurePaths.jl/dev/)
5+
[![Build Status](https://github.com/okatsn/HiveStructurePaths.jl/actions/workflows/CI.yml/badge.svg?branch=main)](https://github.com/okatsn/HiveStructurePaths.jl/actions/workflows/CI.yml?query=branch%3Amain)
6+
[![Coverage](https://codecov.io/gh/okatsn/HiveStructurePaths.jl/branch/main/graph/badge.svg)](https://codecov.io/gh/okatsn/HiveStructurePaths.jl)
77

88
<!-- Don't have any of your custom contents above; they won't occur if there is no citation. -->
99

10-
[![](https://img.shields.io/badge/docs-stable-blue.svg)](https://okatsn.github.io/HivePaths.jl/stable)
11-
[![](https://img.shields.io/badge/docs-dev-blue.svg)](https://okatsn.github.io/HivePaths.jl/dev)
10+
[![](https://img.shields.io/badge/docs-stable-blue.svg)](https://okatsn.github.io/HiveStructurePaths.jl/stable)
11+
[![](https://img.shields.io/badge/docs-dev-blue.svg)](https://okatsn.github.io/HiveStructurePaths.jl/dev)
1212

13-
HivePaths provides utilities for working with Hive-style partitioned file hierarchies, where data is organized using `key=value` directory structures.
13+
HiveStructurePaths provides utilities for working with Hive-style partitioned file hierarchies, where data is organized using `key=value` directory structures.
1414

1515
## Purpose
1616

17-
When managing datasets partitioned across multiple dimensions (e.g., `criterion=depth/partition=1/k=10/data.arrow`), HivePaths helps you:
17+
When managing datasets partitioned across multiple dimensions (e.g., `criterion=depth/partition=1/k=10/data.arrow`), HiveStructurePaths helps you:
1818
- **Parse** paths to extract partition metadata
1919
- **Build** paths with consistent hierarchical ordering
2020
- **Find** all files matching a specific schema
@@ -24,7 +24,7 @@ Each `HiveSchema` defines one target filename and the hierarchical structure of
2424
## Example
2525

2626
```julia
27-
using HivePaths
27+
using HiveStructurePaths
2828

2929
# Define the schema
3030
schema = HiveSchema(

docs/Project.toml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,3 @@
11
[deps]
22
Documenter = "e30172f5-a6a5-5a46-863b-614d45cd2de4"
3-
HivePaths = "67cf009d-4aa4-48c9-a112-d5138c970da1"
3+
HiveStructurePaths = "67cf009d-4aa4-48c9-a112-d5138c970da1"

docs/make.jl

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
using HivePaths
1+
using HiveStructurePaths
22
using Documenter
33
# using DocumenterCitations
44
# # 1. Uncomment this line and the CitationBibliography line
@@ -7,16 +7,16 @@ using Documenter
77
# # Please refer https://juliadocs.org/DocumenterCitations.jl/stable/
88

99

10-
DocMeta.setdocmeta!(HivePaths, :DocTestSetup, :(using HivePaths); recursive=true)
10+
DocMeta.setdocmeta!(HiveStructurePaths, :DocTestSetup, :(using HiveStructurePaths); recursive=true)
1111

1212
makedocs(;
13-
modules=[HivePaths],
13+
modules=[HiveStructurePaths],
1414
authors="okatsn <okatsn@gmail.com> and contributors",
15-
repo="https://github.com/okatsn/HivePaths.jl/blob/{commit}{path}#{line}",
16-
sitename="HivePaths.jl",
15+
repo="https://github.com/okatsn/HiveStructurePaths.jl/blob/{commit}{path}#{line}",
16+
sitename="HiveStructurePaths.jl",
1717
format=Documenter.HTML(;
1818
prettyurls=get(ENV, "CI", "false") == "true",
19-
canonical="https://okatsn.github.io/HivePaths.jl",
19+
canonical="https://okatsn.github.io/HiveStructurePaths.jl",
2020
edit_link="main",
2121
assets=String[],
2222
),
@@ -29,6 +29,6 @@ makedocs(;
2929
)
3030

3131
deploydocs(;
32-
repo="github.com/okatsn/HivePaths.jl",
32+
repo="github.com/okatsn/HiveStructurePaths.jl",
3333
devbranch="main",
3434
)

docs/src/index.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,14 @@
11
```@meta
2-
CurrentModule = HivePaths
2+
CurrentModule = HiveStructurePaths
33
```
44

5-
# HivePaths
5+
# HiveStructurePaths
66

7-
Documentation for [HivePaths](https://github.com/okatsn/HivePaths.jl).
7+
Documentation for [HiveStructurePaths](https://github.com/okatsn/HiveStructurePaths.jl).
88

99
```@index
1010
```
1111

1212
```@autodocs
13-
Modules = [HivePaths]
13+
Modules = [HiveStructurePaths]
1414
```

src/HivePaths.jl

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
module HivePaths
1+
module HiveStructurePaths
22

33
export HiveSchema, parse_hive_path, build_hive_path, find_hive_files
44

test/hivepaths.jl

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
@testset "HivePaths Tests" begin
1+
@testset "HiveStructurePaths Tests" begin
22

33
# --- Setup: Define a standard Schema for Seismology ---
44
TEST_SCHEMA = HiveSchema(

test/runtests.jl

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
using Test
22
# using TestItems
3-
using HivePaths
3+
using HiveStructurePaths
44

55
function targetlist(targetexpr::Regex, dir2walk::AbstractString)
66
# targetexpr = r"(\.jl)$";
@@ -19,7 +19,7 @@ end
1919

2020
(testfiles, allnames) = targetlist(r"^(?!runtests).*(\.jl)$", "./");
2121
# pwd() here should be "./test/"
22-
@testset "HivePaths.jl" begin
22+
@testset "HiveStructurePaths.jl" begin
2323
for f in testfiles
2424
# write test in the file of the same name.
2525
# E.g., `test/mycode.jl` for testing `src/mycode.jl`.
@@ -29,12 +29,12 @@ end
2929

3030
using Documenter
3131
@testset "DocTests" begin
32-
DocMeta.setdocmeta!(HivePaths, :DocTestSetup, :(using HivePaths); recursive=true)
32+
DocMeta.setdocmeta!(HiveStructurePaths, :DocTestSetup, :(using HiveStructurePaths); recursive=true)
3333
# using the package everywhere in the doc
3434
# See also https://documenter.juliadocs.org/stable/man/doctests/#Setup-Code
3535

3636

37-
doctest(HivePaths; manual = false) # this makes jldoctest also be tested in a local test
37+
doctest(HiveStructurePaths; manual = false) # this makes jldoctest also be tested in a local test
3838
end
3939

4040
using CompatHelperLocal

0 commit comments

Comments
 (0)