Merge branch 'master' into jn/ambig-getobj

Author: lgoettgens

.github/workflows/docs.yml

@@ -8,6 +8,11 @@ on:
   pull_request:
   workflow_dispatch:
 
+# needed to allow julia-actions/cache to delete old caches that it has created
+permissions:
+  actions: write
+  contents: read
+
 concurrency:
   # group by workflow and ref; the last slightly strange component ensures that for pull
   # requests, we limit to 1 concurrent job, but for the master branch we don't

.github/workflows/test.yml

@@ -8,6 +8,11 @@ on:
   pull_request:
   workflow_dispatch:
 
+# needed to allow julia-actions/cache to delete old caches that it has created
+permissions:
+  actions: write
+  contents: read
+
 concurrency:
   # group by workflow and ref; the last slightly strange component ensures that for pull
   # requests, we limit to 1 concurrent job, but for the master branch we don't
@@ -32,26 +37,20 @@ jobs:
           - '1.8'
           - '1.7'
           - '1.6'
-          - '1.5'
-          - '1.4'
-          - '1.3'
-          - '1.2'
-          - '1.1'
-          - '1.0'
           - 'nightly'
         include:
           - os: windows-latest
             julia-version: '1'
           - os: windows-latest
-            julia-version: '1.0'
+            julia-version: '1.6'
           - os: windows-latest
             julia-version: '1.12-nightly'
           - os: windows-latest
             julia-version: 'nightly'
           - os: macOS-latest
             julia-version: '1'
           - os: macOS-13 # macOS-14 and later require julia >= 1.8
-            julia-version: '1.0'
+            julia-version: '1.6'
           - os: macOS-latest
             julia-version: '1.12-nightly'
           - os: macOS-latest
@@ -67,6 +66,7 @@ jobs:
         uses: julia-actions/setup-julia@v2
         with:
           version: ${{ matrix.julia-version }}
+      - uses: julia-actions/cache@v2
       - uses: julia-actions/julia-runtest@v1
         with:
           depwarn: error

CHANGELOG.md

@@ -5,6 +5,18 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+## Version [v1.0.0] - unreleased
+
+### Changed
+
+- The minimum supported julia version is increased to 1.6. ([#328])
+
+## Version [v0.8.12] - 2025-05-05
+
+### Changed
+
+- Add `test_undocumented_names` to verify that all public symbols have docstrings (not including the module itself). This test is not enabled by default in `test_all`. ([#313])
+
 ## Version [v0.8.11] - 2025-02-06
 
 ### Changed
@@ -257,6 +269,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 [v0.8.9]: https://github.com/JuliaTesting/Aqua.jl/releases/tag/v0.8.9
 [v0.8.10]: https://github.com/JuliaTesting/Aqua.jl/releases/tag/v0.8.10
 [v0.8.11]: https://github.com/JuliaTesting/Aqua.jl/releases/tag/v0.8.11
+[v0.8.12]: https://github.com/JuliaTesting/Aqua.jl/releases/tag/v0.8.12
 [#93]: https://github.com/JuliaTesting/Aqua.jl/issues/93
 [#103]: https://github.com/JuliaTesting/Aqua.jl/issues/103
 [#113]: https://github.com/JuliaTesting/Aqua.jl/issues/113
@@ -306,5 +319,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 [#288]: https://github.com/JuliaTesting/Aqua.jl/issues/288
 [#297]: https://github.com/JuliaTesting/Aqua.jl/issues/297
 [#309]: https://github.com/JuliaTesting/Aqua.jl/issues/309
+[#313]: https://github.com/JuliaTesting/Aqua.jl/issues/313
 [#319]: https://github.com/JuliaTesting/Aqua.jl/issues/319
 [#322]: https://github.com/JuliaTesting/Aqua.jl/issues/322
+[#328]: https://github.com/JuliaTesting/Aqua.jl/issues/328

Project.toml

@@ -1,18 +1,18 @@
 name = "Aqua"
 uuid = "4c88cf16-eb10-579e-8560-4a9242c79595"
 authors = ["Takafumi Arakaki <[email protected]> and contributors"]
-version = "0.8.11"
+version = "1.0.0-DEV"
 
 [deps]
 Compat = "34da2185-b29b-5c13-b0c7-acf172513d20"
 Pkg = "44cfe95a-1eb2-52ea-b672-e2afdf69b78f"
 Test = "8dfed614-e22c-5e08-85e1-65c5234f0b40"
 
 [compat]
-Compat = "3.12, 4"
-Pkg = "1.0"
+Compat = "4"
+Pkg = "1.6"
 Test = "<0.0.1, 1"
-julia = "1.0"
+julia = "1.6"
 
 [extras]
 Test = "8dfed614-e22c-5e08-85e1-65c5234f0b40"

docs/make.jl

@@ -29,6 +29,7 @@ makedocs(;
             "deps_compat.md",
             "piracies.md",
             "persistent_tasks.md",
+            "undocumented_names.md",
         ],
         "release-notes.md",
     ],

docs/src/undocumented_names.md

@@ -0,0 +1,7 @@
+# Undocumented names
+
+## [Test function](@id test_undocumented_names)
+
+```@docs
+Aqua.test_undocumented_names
+```

src/Aqua.jl

@@ -1,18 +1,10 @@
 module Aqua
 
-using Base: PkgId, UUID
+using Base: Docs, PkgId, UUID
 using Pkg: Pkg, TOML, PackageSpec
+using Pkg.Types: VersionSpec, semver_spec
 using Test
 
-@static if VERSION < v"1.1.0-DEV.472"
-    using Compat: isnothing
-end
-@static if VERSION < v"1.3.0-DEV.349"
-    using Compat: findfirst
-end
-
-include("pkg/Versions.jl")
-using .Versions: VersionSpec, semver_spec
 
 include("utils.jl")
 include("ambiguities.jl")
@@ -23,6 +15,7 @@ include("stale_deps.jl")
 include("deps_compat.jl")
 include("piracies.jl")
 include("persistent_tasks.jl")
+include("undocumented_names.jl")
 
 """
     test_all(testtarget::Module)
@@ -37,6 +30,7 @@ Run the following tests:
 * [`test_deps_compat(testtarget)`](@ref test_deps_compat)
 * [`test_piracies(testtarget)`](@ref test_piracies)
 * [`test_persistent_tasks(testtarget)`](@ref test_persistent_tasks)
+* [`test_undocumented_names(testtarget)`](@ref test_undocumented_names)
 
 The keyword argument `\$x` (e.g., `ambiguities`) can be used to
 control whether or not to run `test_\$x` (e.g., `test_ambiguities`).
@@ -52,6 +46,7 @@ passed to `\$x` to specify the keyword arguments for `test_\$x`.
 - `deps_compat = true`
 - `piracies = true`
 - `persistent_tasks = true`
+- `undocumented_names = false`
 """
 function test_all(
     testtarget::Module;
@@ -63,6 +58,7 @@ function test_all(
     deps_compat = true,
     piracies = true,
     persistent_tasks = true,
+    undocumented_names = false,
 )
     if ambiguities !== false
         @testset "Method ambiguity" begin
@@ -105,6 +101,13 @@ function test_all(
             test_persistent_tasks(testtarget; askwargs(persistent_tasks)...)
         end
     end
+    @testset "Undocumented names" begin
+        if undocumented_names !== false
+            isempty(askwargs(undocumented_names)) ||
+                error("Keyword arguments not supported")
+            test_undocumented_names(testtarget; askwargs(undocumented_names)...)
+        end
+    end
 end
 
 end # module

src/piracies.jl

@@ -2,19 +2,7 @@ module Piracy
 
 using ..Aqua: is_kwcall
 
-@static if VERSION >= v"1.6-"
-    using Test: is_in_mods
-else
-    function is_in_mods(m::Module, recursive::Bool, mods)
-        while true
-            m in mods && return true
-            recursive || return false
-            p = parentmodule(m)
-            p === m && return false
-            m = p
-        end
-    end
-end
+using Test: is_in_mods
 
 # based on Test/Test.jl#detect_ambiguities
 # https://github.com/JuliaLang/julia/blob/v1.9.1/stdlib/Test/src/Test.jl#L1838-L1896