JuliaPhysics / JuliaPhysics/Unitful.jl

uconvert documentation update

Open
#581 3 comments 0 reactions 0 assignees View on GitHub
documentation
Dominant language
Julia
Stars
675
Forks
124
Avg merge
3h 38m
Merged PRs (30d)
1

Description

Under quickstart in the documentation the uconvert function as written does not work. The documentation should be updated. The first line is a direct copy from the documentation and the second line is what works.

```julia
julia> uconvert(°C, 212°F)
ERROR: UndefVarError: °F not defined
Stacktrace:
[1] top-level scope
@ REPL[24]:1

julia> uconvert(u"°C", 212u"°F")
100//1 °C
```

Contributor guide

No contributing guide indexed for this repository

Research direction

Start in the documentation quickstart and locate the uconvert example shown in the issue. Update the example to use the working unit syntax, then verify that the rendered documentation and example no longer produce the reported UndefVarError.

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
Mostly clear
Newbie friendliness
55/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.