Skip to content

Dedent docstring contents #4023

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Nov 16, 2025
Merged

Dedent docstring contents #4023

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 7 additions & 7 deletions src/systems/analysis_points.jl
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -850,14 +850,14 @@ function handle_loop_openings(sys::AbstractSystem, aps)
end

const DOC_LOOP_OPENINGS = """
- `loop_openings`: A list of analysis points whose connections should be removed and
the outputs set to the input as a part of the linear analysis.
- `loop_openings`: A list of analysis points whose connections should be removed and
the outputs set to the input as a part of the linear analysis.
"""

const DOC_SYS_MODIFIER = """
- `system_modifier`: A function taking the transformed system and applying any
additional transformations, returning the modified system. The modified system
is passed to `linearization_function`.
- `system_modifier`: A function taking the transformed system and applying any
additional transformations, returning the modified system. The modified system
is passed to `linearization_function`.
"""
"""
$(TYPEDSIGNATURES)
Expand Down Expand Up @@ -1021,8 +1021,8 @@ function linearization_function(sys::AbstractSystem,
end

@doc """
get_sensitivity(sys, ap::AnalysisPoint; kwargs)
get_sensitivity(sys, ap_name::Symbol; kwargs)
get_sensitivity(sys, ap::AnalysisPoint; kwargs)
get_sensitivity(sys, ap_name::Symbol; kwargs)
Compute the sensitivity function in analysis point `ap`. The sensitivity function is obtained by introducing an infinitesimal perturbation `d` at the input of `ap`, linearizing the system and computing the transfer function between `d` and the output of `ap`.
Expand Down