Skip to content

docs: fix FAQ docs, improve analysis point error message #3743

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 2 commits into from
Jun 17, 2025
Merged

docs: fix FAQ docs, improve analysis point error message #3743

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
1843ac1
docs: fix incorrect FAQ section
AayushSabharwal Jun 17, 2025
d0765de
refactor: improve error message for incorrectly named analysis point
AayushSabharwal Jun 17, 2025
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
2 changes: 1 addition & 1 deletion docs/src/basics/FAQ.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ are similarly undocumented. Following is the list of behaviors that should be re
parameter with the given index.
- `setindex!(::MTKParameters, value, ::ParameterIndex)` can be used to set the value of a
parameter with the given index.
- `parameter_values(sys, sym)` will return a `ParameterIndex` object if `sys` has been
- `parameter_index(sys, sym)` will return a `ParameterIndex` object if `sys` has been
`complete`d (through `mtkcompile`, `complete` or `@mtkcompile`).
- `copy(::MTKParameters)` is defined and duplicates the parameter object, including the
memory used by the underlying buffers.
Expand Down
7 changes: 6 additions & 1 deletion src/systems/analysis_points.jl
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -348,7 +348,12 @@ function modify_nested_subsystem(
end
# ignore the name of the root
if nameof(root) != hierarchy[1]
error("The name of the root system $(nameof(root)) must be included in the name passed to `modify_nested_subsystem`")
error("""
Invalid analysis point name `$(join(hierarchy, NAMESPACE_SEPARATOR))`. The name
must include the name of the root system `$(nameof(root))`. This typically happens
when using an analysis point obtained by calling `getproperty` on a system marked
as `complete` to linearize a system that is not marked as `complete`.
""")
end
hierarchy = @view hierarchy[2:end]

Expand Down
Loading