Skip to content

[Doc] Examples are not displayed correctly in the REPL #173

Description

@amontoison
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)

Activity

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

Labels

documentationImprovements or additions to documentation

Type

No type

Projects

No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions