Skip to content

Commit c6557aa

Browse files
Apply suggestions from code review
Co-Authored-By: Nick Robinson <npr251@gmail.com>
1 parent c1a054f commit c6557aa

File tree

2 files changed

+3
-3
lines changed

2 files changed

+3
-3
lines changed

docs/src/debug_mode.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,13 @@
11
# Debug Mode
22

3-
ChainRules supports a *debug mode* which you can use while writing new rules.
3+
ChainRulesCore supports a *debug mode* which you can use while writing new rules.
44
It provides better error messages.
55
If you are developing some new rules, and you get a weird error message,
66
it is worth enabling debug mode.
77

88
There is some overhead to having it enabled, so it is disabled by default.
99

10-
To enable redefine the []`ChainRulesCore.debug_mode`](@ref) function to return `true`.
10+
To enable, redefine the [`ChainRulesCore.debug_mode`](@ref) function to return `true`.
1111
```julia
1212
ChainRulesCore.debug_mode() = true
1313
```

src/debug_mode.jl

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
"""
2-
debug_mode()
2+
debug_mode() -> Bool
33
44
Determines if ChainRulesCore is in `debug_mode`.
55
Defaults to `false`, but if the user redefines it to return `true` then extra

0 commit comments

Comments
 (0)