Merge pull request #173 from mmaelicke/fix-directional-docs

remove performance warning
mmaelicke · Oct 22, 2023 · e29f161 · e29f161
2 parents a59da91 + dc0af1d
commit e29f161
Showing 1 changed file with 4 additions and 2 deletions.
diff --git a/skgstat/DirectionalVariogram.py b/skgstat/DirectionalVariogram.py
@@ -42,8 +42,10 @@ def __init__(self,
                  ):
         r"""Variogram Class
 
-        Directional Variogram. The calculation is not performant and not
-        tested yet.
+        Directional Variogram. Works similar to the base class, but one can
+        define a ``azimuth`` and a ``tolerance`` angle to only account for
+        point pairs in a user-defined direction. Directional variograms are
+        used to describe anisotropy in the data.
 
         Parameters
         ----------