Explain how to resolve conflict in @profview (#172)

Closes #171
timholy · Oct 9, 2021 · b733705 · b733705
1 parent 3d624a4
commit b733705
Showing 1 changed file with 4 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -51,6 +51,10 @@ using ProfileView
 
 `@profview f(args...)` is just shorthand for `Profile.clear(); @profile f(args...); ProfileView.view()`.
 
+> If you use ProfileView from VSCode you'll get an error `UndefVarError: @profview not defined`.
+> This is because VSCode defines its own `@profview`, which conflicts with ProfileView's.
+> Fix it by using `ProfileView.@profview`.
+
 If you're following along, you should see something like this:
 
 ![ProfileView](readme_images/pv1.png)