]> git.r.bdr.sh - rbdr/api-notation.vim/blobdiff - README.md
Updates readme to show comments and namespacing
[rbdr/api-notation.vim] / README.md
index 993068ce15b3db07b4dab890aaa18a727fa92e0b..5818c72c31b657af8d1771fabb677b45f8b25173 100644 (file)
--- a/README.md
+++ b/README.md
@@ -17,7 +17,7 @@ The most recent reference as of now is in this [gist][api-reference], so
 check that to be sure. But here's a reproduction of the notation.
 
 ```
-Class Members
+NameOfClass.WithPossibleNamespace
    + class property
    - instance property
   ~> listened events (socket)
@@ -37,6 +37,8 @@ Other symbols
 
 Recommended order: class first, then sockets, then instance. Internally:
 Properties, events, methods.
+
+// Anything after two forward slashes is a comment
 ```
 
 ## How does it look like?