Skip to content

Commit

Permalink
Do not use ~ in docstring (rendered as strikethrough in github)
Browse files Browse the repository at this point in the history
  • Loading branch information
tkf committed Oct 26, 2018
1 parent 69bf36f commit b2ccff8
Show file tree
Hide file tree
Showing 2 changed files with 3 additions and 3 deletions.
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -109,7 +109,7 @@ Search functions returning type `Type` in `Module`s. As this search typically t

**Limitations**

* 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.
* 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.
* The functions must be executed (JIT'ed) once for `@searchreturn` to find their returned by type.
* Any IO operations (like printing in REPL) would be slow while the search is active in background.
* 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.
Expand Down
4 changes: 2 additions & 2 deletions src/return.jl
Original file line number Diff line number Diff line change
Expand Up @@ -307,10 +307,10 @@ Calling `kill` (`Base.kill`) on the handle cancels the search.
* 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.
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
second time is fast (a few seconds), even if different `Type` is
specified.
* The functions must be executed (JIT'ed) once for `@searchreturn` to
find their returned by type.
Expand Down

0 comments on commit b2ccff8

Please sign in to comment.