Release v2.0! Set full_signatures = true by default and update README (#33)

* Set `full_signatures = true` by default, since it's more informative!

* Bump to v2.0.0; update README

Author: NHDaly

Project.toml

@@ -1,7 +1,7 @@
 name = "PProf"
 uuid = "e4faabce-9ead-11e9-39d9-4379958e3056"
 authors = ["Valentin Churavy <v.churavy@gmail.com>", "Nathan Daly <nhdaly@gmail.com>"]
-version = "1.2.0"
+version = "2.0.0"
 
 [deps]
 AbstractTrees = "1520ce14-60c1-5f80-bbc7-55ef81b5835c"

README.md

@@ -27,15 +27,16 @@ For more usage examples see the pprof docs: https://github.com/google/pprof/blob
 ## Usage
 ```julia
 help?> pprof
-  pprof(data, period;
+  pprof([data, [lidict]];
           web = true, webhost = "localhost", webport = 57599,
-          out = "profile.pb.gz", from_c = true, drop_frames = "", keep_frames = "",
-          ui_relative_percentages = true,
-       )
+          out = "profile.pb.gz", from_c = true, full_signatures = true, drop_frames = "",
+          keep_frames = "", ui_relative_percentages = true, sampling_delay = nothing,
+        )
+  pprof(FlameGraphs.flamegraph(); kwargs...)
 
-  Fetches the collected Profile data, exports to the pprof format, and (optionally) opens a pprof web-server for interactively
-  viewing the results.
-  ```
+  Fetches the collected `Profile` data, exports to the `pprof` format, and (optionally) opens
+  a `pprof` web-server for interactively viewing the results.
+```
 ```julia
 help?> @pprof
   @pprof ex
@@ -62,4 +63,4 @@ Serving web UI on http://localhost:57599
 ## Google PProf Web View
 <img width=500px src="docs/graph.png" alt="graph"/>
 
-!["flamegraph"](docs/flamegraph.png)
+<img width=500px src="docs/flamegraph.png" alt="flamegraph"/>

docs/flamegraph.png

@@ -51,7 +51,7 @@ using Base.StackTraces: StackFrame
 """
     pprof([data, [lidict]];
             web = true, webhost = "localhost", webport = 57599,
-            out = "profile.pb.gz", from_c = true, full_signatures = false, drop_frames = "",
+            out = "profile.pb.gz", from_c = true, full_signatures = true, drop_frames = "",
             keep_frames = "", ui_relative_percentages = true, sampling_delay = nothing,
          )
     pprof(FlameGraphs.flamegraph(); kwargs...)
@@ -81,8 +81,8 @@ You can also use `PProf.refresh(file="...")` to open a new file in the server.
 - `webport::Integer`: If using `web`, which port to launch the webserver on.
 - `out::String`: Filename for output.
 - `from_c::Bool`: If `false`, exclude frames that come from from_c. Defaults to `true`.
-- `full_signatures::Bool`: If `true`, methods are printed as signatures with full
-                           argument types. E.g. `eval(::Module, ::Any)` instead of `eval`.
+- `full_signatures::Bool`: If `true`, methods are printed as signatures with full argument
+                           types. If `false`, as only names. E.g. `eval(::Module, ::Any)` vs `eval`.
 - `drop_frames`: frames with function_name fully matching regexp string will be dropped from the samples,
                  along with their successors.
 - `keep_frames`: frames with function_name fully matching regexp string will be kept, even if it matches drop_functions.
@@ -97,7 +97,7 @@ function pprof(data::Union{Nothing, Vector{UInt}} = nothing,
                webport::Integer = 57599,
                out::AbstractString = "profile.pb.gz",
                from_c::Bool = true,
-               full_signatures::Bool = false,
+               full_signatures::Bool = true,
                drop_frames::Union{Nothing, AbstractString} = nothing,
                keep_frames::Union{Nothing, AbstractString} = nothing,
                ui_relative_percentages::Bool = true,

src/PProf.jl

@@ -12,7 +12,7 @@ function pprof(fg::Node{NodeData},
     webport::Integer = 57599,
     out::AbstractString = "profile.pb.gz",
     from_c::Bool = true,
-    full_signatures::Bool = false,
+    full_signatures::Bool = true,
     drop_frames::Union{Nothing, AbstractString} = nothing,
     keep_frames::Union{Nothing, AbstractString} = nothing,
     ui_relative_percentages::Bool = true,