Commit d896d40
Document the explicit FunctionWrappersWrapper{FW, P, CS}(fw, cs) constructor (#79)
* Restore the ExplicitImports ignores dropped in #76
#76 replaced the whole `run_qa(...)` call with a bare
`run_qa(FunctionWrappersWrappers)`, which silently discarded the
`all_qualified_accesses_are_public` ignore list it carried. The QA group has
errored on `main` ever since with `NonPublicQualifiedAccessException` for
`FunctionWrappers.FunctionWrapper` and
`TruncatedStacktraces.@truncate_stacktrace`.
This is invisible to `Pkg.test()`, which runs the curated default group; QA is
not part of it.
`:tail` is not restored: `Base.tail` is no longer reached, and ExplicitImports
does not flag it.
Co-Authored-By: Chris Rackauckas <accounts@chrisrackauckas.com>
* Drop the dead TruncatedStacktraces dependency
`@truncate_stacktrace` cannot fire in this package. TruncatedStacktraces sets
`DISABLE = @load_preference("disable", true) || VERSION >= v"1.10"`, and the
macro body is wrapped in `@static if !DISABLE`, so on Julia 1.10 and later it
expands to nothing — and 1.10 is this package's floor. The `Base.show` method it
is supposed to define has never existed on any Julia version we support, and the
preference cannot override the version clause.
Verified: `FunctionWrappersWrapper` contributes zero `Base.show` methods, and
its type prints in full with no truncation.
That makes the dependency dead weight, and it was the only reason the QA suite
needed a `@truncate_stacktrace` ignore. Removing it is better than either
ignoring the access or promoting the name upstream — the latter is impossible
in any case, since SciML/TruncatedStacktraces.jl is archived and read-only.
Only the `FunctionWrapper` ignore remains, and that one has a path out now:
JuliaLang/FunctionWrappers.jl#35.
Co-Authored-By: Chris Rackauckas <accounts@chrisrackauckas.com>
* Document the explicit FunctionWrappersWrapper{FW, P, CS}(fw, cs) constructor
`FunctionWrappersWrapper` is exported, so its inner constructor was already
reachable as public API, but it carried no docstring — the only constructor of
the type that did not. Downstream solver stacks construct through exactly this
method, because supplying `FW`, `P` and `CS` directly keeps the wrapper type
inferrable without relying on constant propagation through a keyword-argument
frame, which the `argtypes`/`rettypes` and tuple constructors do.
The docstring is attached with `@doc` on the method signature after the struct;
a docstring written inside the struct body does not attach to the type's
binding, so Documenter would never render it.
Co-Authored-By: Chris Rackauckas <accounts@chrisrackauckas.com>
---------
Co-authored-by: ChrisRackauckas-Claude <accounts@chrisrackauckas.com>1 parent 689ef3b commit d896d40
3 files changed
Lines changed: 57 additions & 6 deletions
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
1 | 1 | | |
2 | 2 | | |
3 | 3 | | |
4 | | - | |
| 4 | + | |
5 | 5 | | |
6 | 6 | | |
7 | 7 | | |
8 | 8 | | |
9 | 9 | | |
10 | | - | |
11 | 10 | | |
12 | 11 | | |
13 | 12 | | |
| |||
28 | 27 | | |
29 | 28 | | |
30 | 29 | | |
31 | | - | |
32 | 30 | | |
33 | 31 | | |
34 | 32 | | |
| |||
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
2 | 2 | | |
3 | 3 | | |
4 | 4 | | |
5 | | - | |
6 | 5 | | |
7 | 6 | | |
8 | 7 | | |
| |||
223 | 222 | | |
224 | 223 | | |
225 | 224 | | |
226 | | - | |
| 225 | + | |
| 226 | + | |
| 227 | + | |
| 228 | + | |
| 229 | + | |
| 230 | + | |
| 231 | + | |
| 232 | + | |
| 233 | + | |
| 234 | + | |
| 235 | + | |
| 236 | + | |
| 237 | + | |
| 238 | + | |
| 239 | + | |
| 240 | + | |
| 241 | + | |
| 242 | + | |
| 243 | + | |
| 244 | + | |
| 245 | + | |
| 246 | + | |
| 247 | + | |
| 248 | + | |
| 249 | + | |
| 250 | + | |
| 251 | + | |
| 252 | + | |
| 253 | + | |
| 254 | + | |
| 255 | + | |
| 256 | + | |
| 257 | + | |
| 258 | + | |
| 259 | + | |
| 260 | + | |
| 261 | + | |
| 262 | + | |
| 263 | + | |
| 264 | + | |
| 265 | + | |
| 266 | + | |
| 267 | + | |
227 | 268 | | |
228 | 269 | | |
229 | 270 | | |
| |||
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
1 | 1 | | |
2 | 2 | | |
3 | | - | |
| 3 | + | |
| 4 | + | |
| 5 | + | |
| 6 | + | |
| 7 | + | |
| 8 | + | |
| 9 | + | |
| 10 | + | |
| 11 | + | |
| 12 | + | |
| 13 | + | |
| 14 | + | |
| 15 | + | |
0 commit comments