SciML / SciML/ModelingToolkitStandardLibrary.jl

DOC: unnamed TimeVaryingFunction in tutorial

Open Beginner friendly
#253 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

bug
Dominant language
Julia
Stars
171
Forks
49
Avg merge
15h 50m
Merged PRs (30d)
10

Description

Working my way through the tutorial, there was a stumbling in the TimeVaryingFunction component.

Is this right?

https://github.com/SciML/ModelingToolkitStandardLibrary.jl/blob/2029edb9f99ccc0c94ade6de6d6c7378264816e2/docs/src/tutorials/input_component.md?plain=1#L25

It raises (in Julia 1.10.0)

ERROR: LoadError: UndefKeywordError: keyword argument name not assigned

If it's @named:

    @named src = TimeVaryingFunction(f)

all's well.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Open docs/src/tutorials/input_component.md around line 25 and reproduce the tutorial with Julia 1.10.0. Check the TimeVaryingFunction example and its named-component usage; done means the documented example runs without the UndefKeywordError and remains consistent with the tutorial.

Written by the indexing model from the issue text.

Assessment

Tech stack
julia
Domain
documentation
Issue type
Documentation
Difficulty
1/5
Estimated time
Under an hour
Activity status
Stale
Clarity
Clearly specified
Newbie friendliness
68/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.