update threaded docstring

rafaqz · Oct 8, 2023 · 28406e6 · 28406e6
1 parent 73101f5
commit 28406e6
Showing 1 changed file with 6 additions and 5 deletions.
diff --git a/src/methods/shared_docstrings.jl b/src/methods/shared_docstrings.jl
@@ -28,11 +28,12 @@ const SHAPE_KEYWORDS = """
 """
 
 const THREADED_KEYWORD = """
-- `threaded`: run operations in parallel. `false` by default. In some circumstances `threaded` 
-    can give large speedups over single threaded operation. But with very large rasters threading
-    may be counter productive due to excessing memory use. Caution should also be used: `threaded`
-    should not be used in in-place functions wrinting to `BitArray` or other arrays where race
-    conditions can occur. 
+- `threaded`: run operations in parallel, `false` by default. In some circumstances `threaded` 
+    can give large speedups over single-threaded operation. This can be true for complicated 
+    geometries written into low-resolution rasters, but may not be for simple geometries with 
+    high-resolution rasters. With very large rasters threading may be counter productive due 
+    to excessing memory use. Caution should also be used: `threaded` should not be used in in-place 
+    functions wrinting to `BitArray` or other arrays where race conditions can occur. 
 """
 
 const GEOM_KEYWORDS = """