Fix small things in docs

scienxlab · Sep 28, 2023 · 0c1a1b6 · 0c1a1b6
1 parent 0507688
commit 0c1a1b6
Show file tree

Hide file tree

Showing 4 changed files with 39 additions and 9 deletions.
diff --git a/docs/development.md b/docs/development.md
@@ -5,7 +5,7 @@ If you'd like to develop `redflag`, this page should help you get started.
 
 ## Installation
 
-You can install this package with `pip`. The `dev` option will install the packages you need for testing and building the documentation.
+You can install this package with `pip` or `conda`. The `dev` option will install the packages you need for testing and building the documentation.
 
     pip install redflag[dev]
 
@@ -21,7 +21,7 @@ You can run the tests (requires `pytest` and `pytest-cov`) with
 
     pytest
 
-Most of the tests are `doctest` tests, which are contained in the docstrings of this package's functions. It is also possible to add test files to the `tests` folder in the normal way.
+Most of the tests are `doctest` tests, which are contained in the docstrings of this package's functions. There are further tests in the `tests` folder.
 
 
 ## Building the package

diff --git a/docs/installation.md b/docs/installation.md
@@ -2,14 +2,26 @@
 
 At the command line:
 
-    $ pip install redflag
+```shell
+pip install redflag
+```
 
 Or, if you use Conda environments:
 
-    $ conda create -n redflag python=3.9
-    $ conda activate redflag
-    $ pip install redflag
+```shell
+conda install -c conda-forge redflag
+```
 
-For developers, there are also options for installing `tests`, `docs` and `dev` dependencies, e.g. `pip install redflag[dev]` to install all testing and documentation packages.
+You can add the `conda-forge` channel as a source for future installations like so:
+
+```shell
+conda config --add channels conda-forge
+conda config --set channel_priority strict
+```
+
+
+## Optional dependencies
+
+For developers, there is an option to install `dev` dependencies: `pip install redflag[dev]` to install all testing and documentation packages.
 
 If you want to help develop `redflag`, please read [Development](development.md).
diff --git a/docs/notebooks/Tutorial.ipynb b/docs/notebooks/Tutorial.ipynb
@@ -4,7 +4,7 @@
    "cell_type": "markdown",
    "metadata": {},
    "source": [
-    "# Tutorial\n",
+    "# 🚩 Tutorial\n",
     "\n",
     "We're going to look at some features of `redflag`, a library for helping find problems in machine learning pipelines.\n",
     "\n",

diff --git a/docs/notebooks/Using_redflag_with_Pandas.ipynb b/docs/notebooks/Using_redflag_with_Pandas.ipynb
@@ -23,7 +23,7 @@
     {
      "data": {
       "text/plain": [
-       "'0.1.10.dev10+gc36a75a.d20221121'"
+       "'0.4.0rc1'"
       ]
      },
      "execution_count": 1,
@@ -230,6 +230,14 @@
     "df.head()"
    ]
   },
+  {
+   "cell_type": "markdown",
+   "id": "d77e460b-b925-4dec-b56d-d3f18ed1ecbb",
+   "metadata": {},
+   "source": [
+    "## Series accessor"
+   ]
+  },
   {
    "cell_type": "markdown",
    "id": "98f5c772-a33d-43cf-82cf-54dc21535133",
@@ -381,6 +389,16 @@
    "source": [
     "This is an experimental feature; future releases will have more functions. Feedback welcome!"
    ]
+  },
+  {
+   "cell_type": "markdown",
+   "id": "ba98b9a2-e0a4-4ed8-a2d4-f87eb882af40",
+   "metadata": {},
+   "source": [
+    "## DataFrame accessor\n",
+    "\n",
+    "Coming soon!"
+   ]
   }
  ],
  "metadata": {