Document the type property

Amphiluke · Aug 30, 2017 · 5580f4c · 5580f4c
1 parent 0e3cf90
commit 5580f4c
Show file tree

Hide file tree

Showing 2 changed files with 6 additions and 666 deletions.
diff --git a/README.md b/README.md
@@ -154,9 +154,13 @@ You may instantiate the `Varshni3` class as follows:
 let varshni = new potprox.Varshni3({d0: 0.0368, r0: 5.389, b: 0.0597});
 ```
 
-### Potential class methods
+### Potential class members
 
-All the classes in the `potprox` object have a few common methods listed below.
+All the classes in the `potprox` object have a few members listed below.
+
+#### `type`
+
+The *static* read-only property containing the name of the potential class (e.g. `"LennardJones"`, `"Morse"`, `"Buckingham"` etc.).
 
 #### `from(data [, settings])`