Update docs for Room.extrude (#200)

LCAV · Nov 24, 2020 · 869ebc3 · 869ebc3
1 parent 648b1da
commit 869ebc3
Show file tree

Hide file tree

Showing 2 changed files with 8 additions and 3 deletions.
diff --git a/CHANGELOG.rst b/CHANGELOG.rst
@@ -15,6 +15,7 @@ Bugfix
 ~~~~~~
 
 - Fixes typo in a docstring
+- Update docs to better reflect actual function parameters
 
 `0.4.2`_ - 2020-09-24
 ---------------------

diff --git a/pyroomacoustics/room.py b/pyroomacoustics/room.py
@@ -1099,15 +1099,19 @@ def extrude(
         ----------
         height : float
             The extrusion height
-        v_vec : array-like 1D length 3, optionnal
+        v_vec : array-like 1D length 3, optional
             A unit vector. An orientation for the extrusion direction. The
             ceiling will be placed as a translation of the floor with respect
             to this vector (The default is [0,0,1]).
-        absorption : float or array-like
+        absorption : float or array-like, optional
             Absorption coefficients for all the walls. If a scalar, then all the walls
             will have the same absorption. If an array is given, it should have as many elements
             as there will be walls, that is the number of vertices of the polygon plus two. The two
-            last elements are for the floor and the ceiling, respectively. (default 1)
+            last elements are for the floor and the ceiling, respectively.
+            It is recommended to use materials instead of absorption parameter. (Default: 1)
+        materials : dict
+            Absorption coefficients for floor and ceiling. This parameter overrides absorption.
+            (Default: {"floor": 1, "ceiling": 1})
         """
 
         if self.dim != 2: