Fix conditional ordering in README and readme_test.ipynb

LBL-EESA · Sep 28, 2024 · b9c71df · b9c71df
1 parent cebd41d
commit b9c71df
Show file tree

Hide file tree

Showing 2 changed files with 6 additions and 2 deletions.
diff --git a/README.md b/README.md
@@ -77,7 +77,9 @@ conditional
 #***************************
 # Calculate the conditional
 #***************************
-cPDF = fastkde.conditional(y, x, var_names = ['y', 'x'])
+# note that conditiong variables ('x' in this case) are listed first
+# in the var_names argument
+cPDF = fastkde.conditional(y, x, var_names = ['x', 'y'])
 ```
 
 The following plot shows the results:

diff --git a/examples/readme_test.ipynb b/examples/readme_test.ipynb
@@ -215,7 +215,9 @@
     "# ***************************\n",
     "# Calculate the conditional\n",
     "# ***************************\n",
-    "cPDF = fastkde.conditional(y, x, var_names=[\"y\", \"x\"])"
+    "# note that conditiong variables ('x' in this case) are listed first\n",
+    "# in the var_names argument\n",
+    "cPDF = fastkde.conditional(y, x, var_names=[\"x\", \"y\"])"
    ]
   },
   {