LEGWORK icon indicating copy to clipboard operation
LEGWORK copied to clipboard

Typo in Code Snippet for plot_sensitivity_curve() Example

Open astrokang opened this issue 6 months ago • 1 comments

Which documentation page is causing an issue?

The Visualisation tutorial: https://legwork.readthedocs.io/en/latest/notebooks/Visualisation.html

What is the problem?

In the Plot sensitivity curves LISA curve section: I noticed a small typo in the code snippet:

frequency_range = frequency_range=np.logspace(-4, 0, 1000) * u.Hz
fig, ax = vis.plot_sensitivity_curve(frequency_range=frequency_range, y_quantity="h_c")

The first line contains a redundant assignment (frequency_range = frequency_range=).

Suggested solution (optional)

It should be corrected to:

frequency_range = np.logspace(-4, 0, 1000) * u.Hz
fig, ax = vis.plot_sensitivity_curve(frequency_range=frequency_range, y_quantity="h_c")

Just a minor fix, but it may help prevent confusion for new users running the example code.

astrokang avatar Apr 14 '25 21:04 astrokang