Skip to content

Commit e06fa05

Browse files
committed
Make Documenter happy
Give new docstrings a home in the manual
1 parent 5e4413b commit e06fa05

File tree

3 files changed

+1
-25
lines changed

3 files changed

+1
-25
lines changed

docs/src/internal_api.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,6 @@
77
without deprecation.
88

99
```@autodocs
10-
Modules = [Enzyme.Compiler]
10+
Modules = [Enzyme.Compiler, Enzyme.Compiler.RecursiveMaps]
1111
Order = [:module, :type, :constant, :macro, :function]
1212
```

src/typeutils/recursive_add.jl

-12
Original file line numberDiff line numberDiff line change
@@ -3,10 +3,6 @@ using .RecursiveMaps: RecursiveMaps, recursive_map, recursive_map!
33
"""
44
recursive_add(x::T, y::T, f=identity, forcelhs=guaranteed_const)
55
6-
!!! warning
7-
Internal function, documented for developer convenience but not covered by semver API
8-
stability guarantees
9-
106
Recursively construct `z::T` such that `zi = xi + f(yi)` where `zi`, `xi`, and `yi` are
117
corresponding values from `z`, `x`, and `y`. In other words, this is a recursive
128
generalization of `x .+ f.(y)`.
@@ -37,10 +33,6 @@ end
3733
f, seen::IdDict, config::RecursiveMaps.InactiveConfig=RecursiveMaps.InactiveConfig()
3834
)
3935
40-
!!! warning
41-
Internal function, documented for developer convenience but not covered by semver API
42-
stability guarantees
43-
4436
Recursively accumulate from values into keys, generalizing `key .+= f.(value)` to arbitrary
4537
types. This accumulation is applied to each key-value pair in `seen::IdDict` where each key
4638
is of a mutable or non-isbits vector type and the corresponding value is of the same type
@@ -93,10 +85,6 @@ end
9385
"""
9486
accumulate_into!(into::T, from::T)
9587
96-
!!! warning
97-
Internal function, documented for developer convenience but not covered by semver API
98-
stability guarantees
99-
10088
Recursively accumulate from `from` into `into` and zero `from`, such that `into_i += from_i`
10189
and `from_i = 0`, where `into_i` and `from_i` are corresponding values within `into` and
10290
`from`. In other words, this is a recursive generalization of

src/typeutils/recursive_maps.jl

-12
Original file line numberDiff line numberDiff line change
@@ -12,10 +12,6 @@ using ..Compiler: guaranteed_const, guaranteed_const_nongen, guaranteed_nonactiv
1212
config = InactiveConfig{copy_if_inactive::Bool,runtime_inactive::Bool}(extra)
1313
newconfig = InactiveConfig(config::InactiveConfig, extra)
1414
15-
!!! warning
16-
Internal type, documented for developer convenience but not covered by semver API
17-
stability guarantees
18-
1915
Config type for specifying which parts of objects should be skipped by `recursive_map{!}`.
2016
2117
At a minimum, parts that Enzyme always considers inactive are skipped. An inactive type is a
@@ -110,10 +106,6 @@ end
110106
config::InactiveConfig=InactiveConfig(),
111107
)::T
112108
113-
!!! warning
114-
Internal function, documented for developer convenience but not covered by semver API
115-
stability guarantees
116-
117109
Recurse through `Nin` objects `xs = (x1::T, x2::T, ..., xNin::T)` of the same type, mapping
118110
the function `f` over every differentiable value encountered and building `Nout` new objects
119111
`(y1::T, ...)` from the resulting values `(y1_i, ...) = f(x1_i, ..., xNin_i)`. Only
@@ -468,10 +460,6 @@ end
468460
isinactivetype::InactiveConfig=InactiveConfig(),
469461
)::Nothing
470462
471-
!!! warning
472-
Internal function, documented for developer convenience but not covered by semver API
473-
stability guarantees
474-
475463
Recurse through `Nin` objects `xs = (x1::T, x2::T, ..., xNin::T)` of the same type, mapping
476464
the function `f!!` over every differentiable value encountered and updating `(y1::T, ...)`
477465
in-place with the resulting values.

0 commit comments

Comments
 (0)