Skip to content

Commit e5e77bd

Browse files
committed
Add a module docstring
1 parent 98cb397 commit e5e77bd

File tree

1 file changed

+11
-1
lines changed

1 file changed

+11
-1
lines changed

src/CodeTracking.jl

Lines changed: 11 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,13 @@
1+
"""
2+
CodeTracking can be thought of as an extension of InteractiveUtils, and pairs well with Revise.jl.
3+
4+
- `code_string`, `@code_string`: fetch the source code (as a string) for a method definition
5+
- `code_expr`, `@code_expr`: fetch the expression for a method definition
6+
- `definition`: a lower-level variant of the above
7+
- `pkgfiles`: return information about the source files that define a package
8+
- `whereis`: Return location information about methods (with Revise, it updates as you edit files)
9+
- `signatures_at`: return the signatures of all methods whose definition spans the specified location
10+
"""
111
module CodeTracking
212

313
using Base: PkgId
@@ -159,7 +169,7 @@ function signatures_at(filename::AbstractString, line::Integer)
159169
end
160170
end
161171
end
162-
error("$filename not found in internal data, perhaps the package is not loaded (or not loaded with `includet`)")
172+
throw(ArgumentError("$filename not found in internal data, perhaps the package is not loaded (or not loaded with `includet`)"))
163173
end
164174

165175
"""

0 commit comments

Comments
 (0)