Skip to content

Commit

Permalink
Make Documenter happy
Browse files Browse the repository at this point in the history
Give new docstrings a home in the manual
  • Loading branch information
danielwe committed Jan 22, 2025
1 parent 94fdb99 commit 3de96f0
Show file tree
Hide file tree
Showing 3 changed files with 1 addition and 25 deletions.
2 changes: 1 addition & 1 deletion docs/src/internal_api.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,6 @@
without deprecation.

```@autodocs
Modules = [Enzyme.Compiler]
Modules = [Enzyme.Compiler, Enzyme.Compiler.RecursiveMaps]
Order = [:module, :type, :constant, :macro, :function]
```
12 changes: 0 additions & 12 deletions src/typeutils/recursive_add.jl
Original file line number Diff line number Diff line change
Expand Up @@ -3,10 +3,6 @@ using .RecursiveMaps: RecursiveMaps, recursive_map, recursive_map!
"""
recursive_add(x::T, y::T, f=identity, forcelhs=guaranteed_const)
!!! warning
Internal function, documented for developer convenience but not covered by semver API
stability guarantees
Recursively construct `z::T` such that `zi = xi + f(yi)` where `zi`, `xi`, and `yi` are
corresponding values from `z`, `x`, and `y`. In other words, this is a recursive
generalization of `x .+ f.(y)`.
Expand Down Expand Up @@ -37,10 +33,6 @@ end
f, seen::IdDict, config::RecursiveMaps.InactiveConfig=RecursiveMaps.InactiveConfig()
)
!!! warning
Internal function, documented for developer convenience but not covered by semver API
stability guarantees
Recursively accumulate from values into keys, generalizing `key .+= f.(value)` to arbitrary
types. This accumulation is applied to each key-value pair in `seen::IdDict` where each key
is of a mutable or non-isbits vector type and the corresponding value is of the same type
Expand Down Expand Up @@ -93,10 +85,6 @@ end
"""
accumulate_into!(into::T, from::T)
!!! warning
Internal function, documented for developer convenience but not covered by semver API
stability guarantees
Recursively accumulate from `from` into `into` and zero `from`, such that `into_i += from_i`
and `from_i = 0`, where `into_i` and `from_i` are corresponding values within `into` and
`from`. In other words, this is a recursive generalization of
Expand Down
12 changes: 0 additions & 12 deletions src/typeutils/recursive_maps.jl
Original file line number Diff line number Diff line change
Expand Up @@ -12,10 +12,6 @@ using ..Compiler: guaranteed_const, guaranteed_const_nongen, guaranteed_nonactiv
config = InactiveConfig{copy_if_inactive::Bool,runtime_inactive::Bool}(extra)
newconfig = InactiveConfig(config::InactiveConfig, extra)
!!! warning
Internal type, documented for developer convenience but not covered by semver API
stability guarantees
Config type for specifying which parts of objects should be skipped by `recursive_map{!}`.
At a minimum, parts that Enzyme always considers inactive are skipped. An inactive type is a
Expand Down Expand Up @@ -110,10 +106,6 @@ end
config::InactiveConfig=InactiveConfig(),
)::T
!!! warning
Internal function, documented for developer convenience but not covered by semver API
stability guarantees
Recurse through `Nin` objects `xs = (x1::T, x2::T, ..., xNin::T)` of the same type, mapping
the function `f` over every differentiable value encountered and building `Nout` new objects
`(y1::T, ...)` from the resulting values `(y1_i, ...) = f(x1_i, ..., xNin_i)`. Only
Expand Down Expand Up @@ -468,10 +460,6 @@ end
isinactivetype::InactiveConfig=InactiveConfig(),
)::Nothing
!!! warning
Internal function, documented for developer convenience but not covered by semver API
stability guarantees
Recurse through `Nin` objects `xs = (x1::T, x2::T, ..., xNin::T)` of the same type, mapping
the function `f!!` over every differentiable value encountered and updating `(y1::T, ...)`
in-place with the resulting values.
Expand Down

0 comments on commit 3de96f0

Please sign in to comment.