Get rid of confusing macro name

Project.toml

@@ -1,7 +1,7 @@
 name = "PrecompileSignatures"
 uuid = "91cefc8d-f054-46dc-8f8c-26e11d7c5411"
 authors = ["Rik Huijzer <[email protected]>"]
-version = "2.0.0"
+version = "3.0.0"
 
 [deps]
 Documenter = "e30172f5-a6a5-5a46-863b-614d45cd2de4"

README.md

@@ -12,24 +12,22 @@ pkg> activate Foo
 (Foo) pkg> add PrecompileSignatures
 ```
 
-Next, add `@precompile_module(Foo)` somewhere after your module's logic.
+Next, add `@precompile_signatures(Foo)` somewhere after your module's logic.
 For example:
 
 ```julia
 module Foo
 
-using PrecompileSignatures: @precompile_module
+using PrecompileSignatures: @precompile_signatures
 
 [...]
 
-# Include generated `precompile` directives for this module.
-@precompile_module(Foo)
+# Generate and run `precompile` directives.
+@precompile_signatures(Foo)
 
 end # module
 ```
 
-This will generate extra `precompile` directives during the precompilation phase and `include` the generated file.
-
 ## How does this package work?
 
 This package finds precompile directives by searching for concrete types in method signatures.

src/PrecompileSignatures.jl

@@ -2,7 +2,7 @@ module PrecompileSignatures
 
 using Documenter.Utilities: submodules
 
-export precompile_directives, write_directives, @precompile_module
+export precompile_directives, write_directives, @precompile_signatures
 
 function _is_macro(f::Function)
     text = sprint(show, MIME"text/plain"(), f)
@@ -241,8 +241,8 @@ function _precompile_type(@nospecialize(argt::Type))
     return ret
 end
 
-"This function is called from within `@precompile_module`."
-function _precompile_module(M::Module, config::Config=Config())
+"This function is called from within `@precompile_signatures`."
+function _precompile_signatures(M::Module, config::Config=Config())
     types = precompilables(M, config)
     for type in types
         _precompile_type(type)
@@ -251,15 +251,15 @@ function _precompile_module(M::Module, config::Config=Config())
 end
 
 """
-    @precompile_module(M)
+    @precompile_signatures(M)
 
 Precompile the concrete signatures in module `M`.
 """
-macro precompile_module(M::Symbol)
+macro precompile_signatures(M::Symbol)
     esc(quote
         if ccall(:jl_generating_output, Cint, ()) == 1
             try
-                $PrecompileSignatures._precompile_module($M)
+                $PrecompileSignatures._precompile_signatures($M)
             catch e
                 msg = "Generating and including the `precompile` directives failed"
                 @warn msg exception=(e, catch_backtrace())
@@ -274,6 +274,6 @@ end
 _test_precompiled(x::Int) = 3
 
 # Include generated `precompile` directives for this module.
-@precompile_module(PrecompileSignatures)
+@precompile_signatures(PrecompileSignatures)
 
 end # module