Skip to content

Outdated docs for generate_control_function #3663

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.

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

Open
Azercoco opened this issue May 27, 2025 · 1 comment
Open

Outdated docs for generate_control_function #3663

Azercoco opened this issue May 27, 2025 · 1 comment
Assignees
Labels
bug Something isn't working

Comments

@Azercoco
Copy link

Azercoco commented May 27, 2025

Describe the bug 🐞

As of 9.79.1, the change of behaviour of generate_control_function has not been documented.

Expected behavior

From #3269, the generated function from generate_control_function expect MTKParameters if split=false is not passed as argument. Passing p as a Vector{Float64} results in some strange undefined behaviour.

The documentation does not reflect this behaviour. Moreover, the example given luckily works with a Vector{Float64}.

The documentation should be updated and a maybe an explicit check should be done to throws an error if a Vector{Float64} is passed when splithas not been set to false.

@Azercoco Azercoco added the bug Something isn't working label May 27, 2025
@ChrisRackauckas
Copy link
Member

I think this is covered in the v10 docs overhaul

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working
Projects
None yet
Development

No branches or pull requests

3 participants