From e65f25cc68548bf0065b33eddf3f4415a04d9ea0 Mon Sep 17 00:00:00 2001
From: Jan Petykiewicz <anewusername@gmail.com>
Date: Mon, 25 Sep 2017 00:43:13 -0700
Subject: [PATCH] Clarify shifts documentation

---
 gridlock/grid.py | 3 +++
 1 file changed, 3 insertions(+)

diff --git a/gridlock/grid.py b/gridlock/grid.py
index 82bbf12..8c9ac26 100644
--- a/gridlock/grid.py
+++ b/gridlock/grid.py
@@ -38,6 +38,9 @@ class Grid(object):
       from the properties named as above, or get them for a given grid by using the
       self.shifted_*xyz(which_shifts) functions.
 
+     The sizes of adjacent cells are taken into account when applying shifts. The
+      total shift for each edge is chosen using (shift * dx_of_cell_being_moved_through).
+
      It is tricky to determine the size of the right-most cell after shifting,
       since its right boundary should shift by shifts[i][a] * dxyz[a][dxyz[a].size],
       where the dxyz element refers to a cell that does not exist.