Skip to content

Commit

Permalink
minor comment fixes
Browse files Browse the repository at this point in the history
  • Loading branch information
ansaminard committed Dec 6, 2024
1 parent b5eef56 commit 8d59fc8
Show file tree
Hide file tree
Showing 2 changed files with 13 additions and 14 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -59,7 +59,7 @@ def __init__(
----------
file : str, default: ""
Path to the harmonics source with two parameters file. Supported files are text files
with the header `AnsysSound_BBN_MultipleParameters`.
with the header `AnsysSound_Orders_MultipleParameters`.
source_control_rpm : SourceControlTime, default: None
First Source control, consisting of the RPM values over time, to use when generating
the sound from this source.
Expand Down Expand Up @@ -253,9 +253,9 @@ def load_source_harmonics_two_parameters(self, file: str):
Parameters
----------
file : str
Path to the harmonics source with two parameters file. Supported files have the
same text format (with the `AnsysSound_Orders_MultipleParameters` header) as that which
is supported by Ansys Sound SAS.
Path to the harmonics source with two parameters file. Supported files have the same
text format (with the `AnsysSound_Orders_MultipleParameters` header) as that which is
supported by Ansys Sound SAS.
"""
# Set operator inputs.
self.__operator_load.connect(0, file)
Expand All @@ -271,8 +271,8 @@ def load_source_harmonics_two_parameters(self, file: str):
def process(self, sampling_frequency: float = 44100.0):
"""Generate the sound of the harmonics source with two parameters.
This method generates the sound of the harmonics source with two parameters, using
the current harmonics source data and source controls.
This method generates the sound of the harmonics source with two parameters, using the
current harmonics source data and source controls.
Parameters
----------
Expand Down Expand Up @@ -366,8 +366,7 @@ def __extract_harmonics_two_parameters_info(
Returns
-------
tuple[list[float], str, tuple[float], str, str, tuple[float]]
Harmonics source with two parameters information, consisting of the following
elements:
Harmonics source with two parameters information, consisting of the following elements:
First element is the list of order values.
Second element is the RPM control name.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -530,8 +530,8 @@ def test_source_harmonics_two_parameters_get_output_as_nparray(dpf_sound_test_se
source_control2 = SourceControlTime()
source_control2.control = f_source_control

# Create a SourceHarmonicsTwoParameters object test source file with less and created
# source controls.
# Create a SourceHarmonicsTwoParameters object test source file with less and created source
# controls.
source_obj = SourceHarmonicsTwoParameters(
file=pytest.data_path_sound_composer_harmonics_source_2p_in_container,
source_control_rpm=source_control_rpm,
Expand Down Expand Up @@ -593,8 +593,8 @@ def test_source_harmonics_two_parameters_plot(dpf_sound_test_server):
source_control2 = SourceControlTime()
source_control2.control = f_source_control

# Create a SourceHarmonicsTwoParameters object test source file with less and created
# source controls.
# Create a SourceHarmonicsTwoParameters object test source file with less and created source
# controls.
source_obj = SourceHarmonicsTwoParameters(
file=pytest.data_path_sound_composer_harmonics_source_2p_in_container,
source_control_rpm=source_control_rpm,
Expand All @@ -611,8 +611,8 @@ def test_source_harmonics_two_parameters_plot_exceptions(dpf_sound_test_server):
with pytest.raises(
PyAnsysSoundException,
match=(
"Output is not processed yet. Use the "
"'SourceHarmonicsTwoParameters.process\\(\\)' method."
"Output is not processed yet. Use the 'SourceHarmonicsTwoParameters.process\\(\\)' "
"method."
),
):
source_obj.plot()
Expand Down

0 comments on commit 8d59fc8

Please sign in to comment.