Skip to content

Commit

Permalink
Update doc strings
Browse files Browse the repository at this point in the history
  • Loading branch information
hagenw committed Mar 21, 2024
1 parent f811dff commit 24256ce
Show file tree
Hide file tree
Showing 3 changed files with 14 additions and 0 deletions.
6 changes: 6 additions & 0 deletions audinterface/core/feature.py
Original file line number Diff line number Diff line change
Expand Up @@ -424,6 +424,7 @@ def process_file(
process_func_args: (keyword) arguments passed on
to the processing function.
They will temporarily overwrite
the ones stored in
:attr:`audinterface.Process.process_func_args`
Raises:
Expand Down Expand Up @@ -469,6 +470,7 @@ def process_files(
process_func_args: (keyword) arguments passed on
to the processing function.
They will temporarily overwrite
the ones stored in
:attr:`audinterface.Process.process_func_args`
Raises:
Expand Down Expand Up @@ -509,6 +511,7 @@ def process_folder(
process_func_args: (keyword) arguments passed on
to the processing function.
They will temporarily overwrite
the ones stored in
:attr:`audinterface.Process.process_func_args`
Raises:
Expand Down Expand Up @@ -572,6 +575,7 @@ def process_index(
process_func_args: (keyword) arguments passed on
to the processing function.
They will temporarily overwrite
the ones stored in
:attr:`audinterface.Process.process_func_args`
Raises:
Expand Down Expand Up @@ -638,6 +642,7 @@ def process_signal(
process_func_args: (keyword) arguments passed on
to the processing function.
They will temporarily overwrite
the ones stored in
:attr:`audinterface.Process.process_func_args`
Raises:
Expand Down Expand Up @@ -682,6 +687,7 @@ def process_signal_from_index(
process_func_args: (keyword) arguments passed on
to the processing function.
They will temporarily overwrite
the ones stored in
:attr:`audinterface.Process.process_func_args`
Raises:
Expand Down
6 changes: 6 additions & 0 deletions audinterface/core/process.py
Original file line number Diff line number Diff line change
Expand Up @@ -308,6 +308,7 @@ def process_file(
process_func_args: (keyword) arguments passed on
to the processing function.
They will temporarily overwrite
the ones stored in
:attr:`audinterface.Process.process_func_args`
Returns:
Expand Down Expand Up @@ -372,6 +373,7 @@ def process_files(
process_func_args: (keyword) arguments passed on
to the processing function.
They will temporarily overwrite
the ones stored in
:attr:`audinterface.Process.process_func_args`
Returns:
Expand Down Expand Up @@ -463,6 +465,7 @@ def process_folder(
process_func_args: (keyword) arguments passed on
to the processing function.
They will temporarily overwrite
the ones stored in
:attr:`audinterface.Process.process_func_args`
Returns:
Expand Down Expand Up @@ -570,6 +573,7 @@ def process_index(
process_func_args: (keyword) arguments passed on
to the processing function.
They will temporarily overwrite
the ones stored in
:attr:`audinterface.Process.process_func_args`
Returns:
Expand Down Expand Up @@ -730,6 +734,7 @@ def process_signal(
process_func_args: (keyword) arguments passed on
to the processing function.
They will temporarily overwrite
the ones stored in
:attr:`audinterface.Process.process_func_args`
Returns:
Expand Down Expand Up @@ -867,6 +872,7 @@ def process_signal_from_index(
process_func_args: (keyword) arguments passed on
to the processing function.
They will temporarily overwrite
the ones stored in
:attr:`audinterface.Process.process_func_args`
Returns:
Expand Down
2 changes: 2 additions & 0 deletions audinterface/core/process_with_context.py
Original file line number Diff line number Diff line change
Expand Up @@ -159,6 +159,7 @@ def process_index(
process_func_args: (keyword) arguments passed on
to the processing function.
They will temporarily overwrite
the ones stored in
:attr:`audinterface.Process.process_func_args`
Returns:
Expand Down Expand Up @@ -272,6 +273,7 @@ def process_signal_from_index(
process_func_args: (keyword) arguments passed on
to the processing function.
They will temporarily overwrite
the ones stored in
:attr:`audinterface.Process.process_func_args`
Returns:
Expand Down

0 comments on commit 24256ce

Please sign in to comment.