control-toolbox / control-toolbox/OptimalControlProblems.jl

[Doc] Examples are not displayed correctly in the REPL

Open
#173 0 comments 1 reaction 1 assignee Claimed by @ocots View on GitHub
documentation
Dominant language
Julia
Stars
13
Forks
1
PR merge metrics
No merged PRs in 30d

Description

```
help?> beam
search: beam break basename rem Real read real reim

DocStringExtensions.TypedMethodSignatures()

Defines the optimal control problem beam for a given back-end.

Arguments
≡≡≡≡≡≡≡≡≡

• model_backend::T: The modelling back-end, subtype of AbstractModelBackend.

• N::Int=0: Number of discretisation steps (optional).

Returns
≡≡≡≡≡≡≡

• Throws an ExtensionError if the required back-end is not available.

Example
≡≡≡≡≡≡≡

julia> beam(JuMPBackend(); N=20)
ERROR: ExtensionError(:JuMP)
```

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.