Skip to content

Commit b2ccff8

Browse files
committed
Do not use ~ in docstring (rendered as strikethrough in github)
1 parent 69bf36f commit b2ccff8

File tree

2 files changed

+3
-3
lines changed

2 files changed

+3
-3
lines changed

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -109,7 +109,7 @@ Search functions returning type `Type` in `Module`s. As this search typically t
109109

110110
**Limitations**
111111

112-
* Running `@searchreturn` for many modules may be slow for the *first* run. Thus, searching from all modules (i.e., not specifying `Module` arguments) may take tens of seconds to minutes, depending of what are loaded. Searching within `Base` takes ~30 seconds. After `DifferentialEquations` is loaded, searching for all modules takes 1.5 minutes. Note that searching from the same module for the second time is fast (~ a few seconds), even if different `Type` is specified.
112+
* Running `@searchreturn` for many modules may be slow for the *first* run. Thus, searching from all modules (i.e., not specifying `Module` arguments) may take tens of seconds to minutes, depending of what are loaded. Searching within `Base` takes about 30 seconds. After `DifferentialEquations` is loaded, searching for all modules takes 1.5 minutes. Note that searching from the same module for the second time is fast (a few seconds), even if different `Type` is specified.
113113
* The functions must be executed (JIT'ed) once for `@searchreturn` to find their returned by type.
114114
* Any IO operations (like printing in REPL) would be slow while the search is active in background.
115115
* Keyboard interruption does not work well while background search is active. You need to hit CTRL-C multiple times to terminate a "foreground" code. Furthermore, it will bring down the background search task as well.

src/return.jl

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -307,10 +307,10 @@ Calling `kill` (`Base.kill`) on the handle cancels the search.
307307
* Running `@searchreturn` for many modules may be slow for the _first_
308308
run. Thus, searching from all modules (i.e., not specifying
309309
`Module` arguments) may take tens of seconds to minutes, depending
310-
of what are loaded. Searching within `Base` takes ~30 seconds.
310+
of what are loaded. Searching within `Base` takes about 30 seconds.
311311
After `DifferentialEquations` is loaded, searching for all modules
312312
takes 1.5 minutes. Note that searching from the same module for the
313-
second time is fast (~ a few seconds), even if different `Type` is
313+
second time is fast (a few seconds), even if different `Type` is
314314
specified.
315315
* The functions must be executed (JIT'ed) once for `@searchreturn` to
316316
find their returned by type.

0 commit comments

Comments
 (0)