Skip to content

Commit 73f8de3

Browse files
docs/ci: canonical sublib README headers + declare ShorthandConstructors test dep
- Sublibrary READMEs: prepend the canonical OrdinaryDiffEq-style badge block (Zulip, Global Docs -> RecursiveArrayTools, ColPrac, SciML Code Style) and the "<Name>.jl is a component of the RecursiveArrayTools.jl monorepo. <role>. While completely independent and usable on its own, users wanting the full functionality should use RecursiveArrayTools.jl." wording, substituting names. Existing content preserved below. - Project.toml: declare RecursiveArrayToolsShorthandConstructors as a proper test dependency — added to [extras], [targets].test, [compat] ("1"), and a [sources] path entry so the Core test group resolves it from the in-repo lib/ on Julia >= 1.11 (runtests.jl Pkg.develop fallback still covers Julia < 1.11 where [sources] is ignored). Verified: project resolves and `VA[...]`/`AP[...]` from the sublibrary load in a Core-test-like environment. Co-Authored-By: Chris Rackauckas <accounts@chrisrackauckas.com> Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
1 parent fbcaca1 commit 73f8de3

4 files changed

Lines changed: 30 additions & 8 deletions

File tree

Project.toml

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -48,6 +48,9 @@ RecursiveArrayToolsTablesExt = ["Tables"]
4848
RecursiveArrayToolsTrackerExt = "Tracker"
4949
RecursiveArrayToolsZygoteExt = "Zygote"
5050

51+
[sources]
52+
RecursiveArrayToolsShorthandConstructors = {path = "lib/RecursiveArrayToolsShorthandConstructors"}
53+
5154
[compat]
5255
Adapt = "4"
5356
Aqua = "0.8"
@@ -68,6 +71,7 @@ Polyester = "0.7.16"
6871
PrecompileTools = "1.2.1"
6972
Random = "1"
7073
RecipesBase = "1.3.4"
74+
RecursiveArrayToolsShorthandConstructors = "1"
7175
ReverseDiff = "1.15"
7276
SafeTestsets = "0.1"
7377
SparseArrays = "1.10"
@@ -95,6 +99,7 @@ NLsolve = "2774e3e8-f4cf-5e23-947b-6d7e65073b56"
9599
Pkg = "44cfe95a-1eb2-52ea-b672-e2afdf69b78f"
96100
Polyester = "f517fe37-dbe3-4b94-8317-1923a5111588"
97101
Random = "9a3f8284-a2c9-5f02-9a11-845980a1fd5c"
102+
RecursiveArrayToolsShorthandConstructors = "39fb7555-b4ad-4efd-8abe-30331df017d3"
98103
SafeTestsets = "1bc83da4-3b8d-516f-aca4-4fe02f6d838f"
99104
SparseArrays = "2f01184e-e22b-5df5-ae63-d93ebab69eaf"
100105
StaticArrays = "90137ffa-7385-5640-81b9-e52037218182"
@@ -106,4 +111,4 @@ Unitful = "1986cc42-f94f-5a68-af5c-568840ba703d"
106111
Zygote = "e88e6eb3-aa80-5325-afca-941959d7151f"
107112

108113
[targets]
109-
test = ["Aqua", "FastBroadcast", "ForwardDiff", "KernelAbstractions", "Measurements", "Mooncake", "NLsolve", "Pkg", "Polyester", "Random", "ReverseDiff", "SafeTestsets", "SparseArrays", "StaticArrays", "Statistics", "StructArrays", "Tables", "Test", "Unitful", "Zygote"]
114+
test = ["Aqua", "FastBroadcast", "ForwardDiff", "KernelAbstractions", "Measurements", "Mooncake", "NLsolve", "Pkg", "Polyester", "Random", "RecursiveArrayToolsShorthandConstructors", "ReverseDiff", "SafeTestsets", "SparseArrays", "StaticArrays", "Statistics", "StructArrays", "Tables", "Test", "Unitful", "Zygote"]

lib/RecursiveArrayToolsArrayPartitionAnyAll/README.md

Lines changed: 8 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,13 @@
11
# RecursiveArrayToolsArrayPartitionAnyAll.jl
22

3-
Optimized `any` and `all` for
4-
[RecursiveArrayTools.jl](https://github.com/SciML/RecursiveArrayTools.jl)'s
5-
`ArrayPartition` type.
3+
[![Join the chat at https://julialang.zulipchat.com #sciml-bridged](https://img.shields.io/static/v1?label=Zulip&message=chat&color=9558b2&labelColor=389826)](https://julialang.zulipchat.com/#narrow/stream/279055-sciml-bridged)
4+
[![Global Docs](https://img.shields.io/badge/docs-SciML-blue.svg)](https://docs.sciml.ai/RecursiveArrayTools/stable/)
5+
6+
[![ColPrac: Contributor's Guide on Collaborative Practices for Community Packages](https://img.shields.io/badge/ColPrac-Contributor%27s%20Guide-blueviolet)](https://github.com/SciML/ColPrac)
7+
[![SciML Code Style](https://img.shields.io/static/v1?label=code%20style&message=SciML&color=9558b2&labelColor=389826)](https://github.com/SciML/SciMLStyle)
8+
9+
RecursiveArrayToolsArrayPartitionAnyAll.jl is a component of the [RecursiveArrayTools.jl](https://github.com/SciML/RecursiveArrayTools.jl) monorepo. Optimized `any` and `all` for the `ArrayPartition` type.
10+
While completely independent and usable on its own, users wanting the full functionality should use [RecursiveArrayTools.jl](https://github.com/SciML/RecursiveArrayTools.jl).
611

712
`ArrayPartition` stores data as a tuple of arrays. The default `AbstractArray`
813
`any`/`all` iterates element-by-element through the partition, which incurs

lib/RecursiveArrayToolsRaggedArrays/README.md

Lines changed: 8 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,13 @@
11
# RecursiveArrayToolsRaggedArrays.jl
22

3-
True ragged (non-rectangular) array types for
4-
[RecursiveArrayTools.jl](https://github.com/SciML/RecursiveArrayTools.jl).
3+
[![Join the chat at https://julialang.zulipchat.com #sciml-bridged](https://img.shields.io/static/v1?label=Zulip&message=chat&color=9558b2&labelColor=389826)](https://julialang.zulipchat.com/#narrow/stream/279055-sciml-bridged)
4+
[![Global Docs](https://img.shields.io/badge/docs-SciML-blue.svg)](https://docs.sciml.ai/RecursiveArrayTools/stable/)
5+
6+
[![ColPrac: Contributor's Guide on Collaborative Practices for Community Packages](https://img.shields.io/badge/ColPrac-Contributor%27s%20Guide-blueviolet)](https://github.com/SciML/ColPrac)
7+
[![SciML Code Style](https://img.shields.io/static/v1?label=code%20style&message=SciML&color=9558b2&labelColor=389826)](https://github.com/SciML/SciMLStyle)
8+
9+
RecursiveArrayToolsRaggedArrays.jl is a component of the [RecursiveArrayTools.jl](https://github.com/SciML/RecursiveArrayTools.jl) monorepo. True ragged (non-rectangular) array types for `RaggedVectorOfArray` and `RaggedDiffEqArray`.
10+
While completely independent and usable on its own, users wanting the full functionality should use [RecursiveArrayTools.jl](https://github.com/SciML/RecursiveArrayTools.jl).
511

612
This subpackage provides `RaggedVectorOfArray` and `RaggedDiffEqArray`, which
713
preserve the exact ragged structure of collections of differently-sized arrays

lib/RecursiveArrayToolsShorthandConstructors/README.md

Lines changed: 8 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,13 @@
11
# RecursiveArrayToolsShorthandConstructors.jl
22

3-
Shorthand constructor syntax for
4-
[RecursiveArrayTools.jl](https://github.com/SciML/RecursiveArrayTools.jl) types.
3+
[![Join the chat at https://julialang.zulipchat.com #sciml-bridged](https://img.shields.io/static/v1?label=Zulip&message=chat&color=9558b2&labelColor=389826)](https://julialang.zulipchat.com/#narrow/stream/279055-sciml-bridged)
4+
[![Global Docs](https://img.shields.io/badge/docs-SciML-blue.svg)](https://docs.sciml.ai/RecursiveArrayTools/stable/)
5+
6+
[![ColPrac: Contributor's Guide on Collaborative Practices for Community Packages](https://img.shields.io/badge/ColPrac-Contributor%27s%20Guide-blueviolet)](https://github.com/SciML/ColPrac)
7+
[![SciML Code Style](https://img.shields.io/static/v1?label=code%20style&message=SciML&color=9558b2&labelColor=389826)](https://github.com/SciML/SciMLStyle)
8+
9+
RecursiveArrayToolsShorthandConstructors.jl is a component of the [RecursiveArrayTools.jl](https://github.com/SciML/RecursiveArrayTools.jl) monorepo. Shorthand `VA[...]` and `AP[...]` constructor syntax for RecursiveArrayTools types.
10+
While completely independent and usable on its own, users wanting the full functionality should use [RecursiveArrayTools.jl](https://github.com/SciML/RecursiveArrayTools.jl).
511

612
This subpackage provides `VA[...]` and `AP[...]` syntax for constructing
713
`VectorOfArray` and `ArrayPartition` objects. It is separated from the main

0 commit comments

Comments
 (0)