AutomaticDocstrings

← Back to package list

If you think that there is an error in how your package is being tested or represented, please file an issue at NewPkgEval.jl, making sure to read the FAQ first.

Results with Julia v1.2.0

Testing was successful. Last evaluation was ago and took 46 seconds.

Click here to download the log file.

 Installed AutomaticDocstrings ─ v0.1.1
 Installed CSTParser ─────────── v1.1.0
 Installed Tokenize ──────────── v0.5.7
  Updating `~/.julia/environments/v1.2/Project.toml`
  [70b36510] + AutomaticDocstrings v0.1.1
  Updating `~/.julia/environments/v1.2/Manifest.toml`
  [70b36510] + AutomaticDocstrings v0.1.1
  [00ebfdb7] + CSTParser v1.1.0
  [0796e94c] + Tokenize v0.5.7
   Testing AutomaticDocstrings
 Resolving package versions...
    Status `/tmp/jl_KHkhB1/Manifest.toml`
  [70b36510] AutomaticDocstrings v0.1.1
  [00ebfdb7] CSTParser v1.1.0
  [0796e94c] Tokenize v0.5.7
  [2a0f44e3] Base64  [`@stdlib/Base64`]
  [8ba89e20] Distributed  [`@stdlib/Distributed`]
  [b77e0a4c] InteractiveUtils  [`@stdlib/InteractiveUtils`]
  [56ddb016] Logging  [`@stdlib/Logging`]
  [d6f4376e] Markdown  [`@stdlib/Markdown`]
  [9a3f8284] Random  [`@stdlib/Random`]
  [9e88b42a] Serialization  [`@stdlib/Serialization`]
  [6462fe0b] Sockets  [`@stdlib/Sockets`]
  [8dfed614] Test  [`@stdlib/Test`]
[ Info: Saved a backup to /tmp/jl_DxyKPx/backup
[ Info: Saved a backup to /tmp/jl_VcuLIN/backup
[ Info: Saved a backup to /tmp/jl_llNi18/backup
Autodoc failed, input:   =====================================
@autodoc
f(a::A, b; c) where A = 5

Result:     ==================================================
"""
    (f(a::A, b; c) where A) = begin

DOCSTRING

#Arguments:
- `a`: DESCRIPTION
- `b`: DESCRIPTION
- `c`: DESCRIPTION
"""
f(a::A, b; c) where A = 5

Expected:   ==================================================
"""
f(a, b; c) where A

DOCSTRING

#Arguments:
- `a`: DESCRIPTION
- `b`: DESCRIPTION
- `c`: DESCRIPTION
"""
f(a::A, b; c) where A = 5

[ Info: Saved a backup to /tmp/jl_XU8oxx/backup
[ Info: Saved a backup to /tmp/jl_jcnza1/backup
[ Info: Saved a backup to /tmp/jl_xig2uF/backup
[ Info: Saved a backup to /tmp/jl_nnanHl/backup
   Testing AutomaticDocstrings tests passed 

Results with Julia v1.3.0

Testing was successful. Last evaluation was ago and took 49 seconds.

Click here to download the log file.

 Resolving package versions...
 Installed AutomaticDocstrings ─ v0.1.1
 Installed Tokenize ──────────── v0.5.7
 Installed CSTParser ─────────── v1.1.0
  Updating `~/.julia/environments/v1.3/Project.toml`
  [70b36510] + AutomaticDocstrings v0.1.1
  Updating `~/.julia/environments/v1.3/Manifest.toml`
  [70b36510] + AutomaticDocstrings v0.1.1
  [00ebfdb7] + CSTParser v1.1.0
  [0796e94c] + Tokenize v0.5.7
   Testing AutomaticDocstrings
 Resolving package versions...
    Status `/tmp/jl_srHyQs/Manifest.toml`
  [70b36510] AutomaticDocstrings v0.1.1
  [00ebfdb7] CSTParser v1.1.0
  [0796e94c] Tokenize v0.5.7
  [2a0f44e3] Base64  [`@stdlib/Base64`]
  [8ba89e20] Distributed  [`@stdlib/Distributed`]
  [b77e0a4c] InteractiveUtils  [`@stdlib/InteractiveUtils`]
  [56ddb016] Logging  [`@stdlib/Logging`]
  [d6f4376e] Markdown  [`@stdlib/Markdown`]
  [9a3f8284] Random  [`@stdlib/Random`]
  [9e88b42a] Serialization  [`@stdlib/Serialization`]
  [6462fe0b] Sockets  [`@stdlib/Sockets`]
  [8dfed614] Test  [`@stdlib/Test`]
[ Info: Saved a backup to /tmp/jl_1woBjf/backup
[ Info: Saved a backup to /tmp/jl_07YZhj/backup
[ Info: Saved a backup to /tmp/jl_5oKhMp/backup
Autodoc failed, input:   =====================================
@autodoc
f(a::A, b; c) where A = 5

Result:     ==================================================
"""
    (f(a::A, b; c) where A) = begin

DOCSTRING

#Arguments:
- `a`: DESCRIPTION
- `b`: DESCRIPTION
- `c`: DESCRIPTION
"""
f(a::A, b; c) where A = 5

Expected:   ==================================================
"""
f(a, b; c) where A

DOCSTRING

#Arguments:
- `a`: DESCRIPTION
- `b`: DESCRIPTION
- `c`: DESCRIPTION
"""
f(a::A, b; c) where A = 5

[ Info: Saved a backup to /tmp/jl_27gvGx/backup
[ Info: Saved a backup to /tmp/jl_lsMh3H/backup
[ Info: Saved a backup to /tmp/jl_ah4fhX/backup
[ Info: Saved a backup to /tmp/jl_b7vo0c/backup
   Testing AutomaticDocstrings tests passed 

Results with Julia v1.3.1-pre-7704df0a5a

Testing was successful. Last evaluation was ago and took 47 seconds.

Click here to download the log file.

 Resolving package versions...
 Installed AutomaticDocstrings ─ v0.1.1
 Installed CSTParser ─────────── v1.1.0
 Installed Tokenize ──────────── v0.5.7
  Updating `~/.julia/environments/v1.3/Project.toml`
  [70b36510] + AutomaticDocstrings v0.1.1
  Updating `~/.julia/environments/v1.3/Manifest.toml`
  [70b36510] + AutomaticDocstrings v0.1.1
  [00ebfdb7] + CSTParser v1.1.0
  [0796e94c] + Tokenize v0.5.7
   Testing AutomaticDocstrings
 Resolving package versions...
    Status `/tmp/jl_NsiLiy/Manifest.toml`
  [70b36510] AutomaticDocstrings v0.1.1
  [00ebfdb7] CSTParser v1.1.0
  [0796e94c] Tokenize v0.5.7
  [2a0f44e3] Base64  [`@stdlib/Base64`]
  [8ba89e20] Distributed  [`@stdlib/Distributed`]
  [b77e0a4c] InteractiveUtils  [`@stdlib/InteractiveUtils`]
  [56ddb016] Logging  [`@stdlib/Logging`]
  [d6f4376e] Markdown  [`@stdlib/Markdown`]
  [9a3f8284] Random  [`@stdlib/Random`]
  [9e88b42a] Serialization  [`@stdlib/Serialization`]
  [6462fe0b] Sockets  [`@stdlib/Sockets`]
  [8dfed614] Test  [`@stdlib/Test`]
[ Info: Saved a backup to /tmp/jl_w62eNQ/backup
[ Info: Saved a backup to /tmp/jl_NQRmg5/backup
[ Info: Saved a backup to /tmp/jl_WTfDpm/backup
Autodoc failed, input:   =====================================
@autodoc
f(a::A, b; c) where A = 5

Result:     ==================================================
"""
    (f(a::A, b; c) where A) = begin

DOCSTRING

#Arguments:
- `a`: DESCRIPTION
- `b`: DESCRIPTION
- `c`: DESCRIPTION
"""
f(a::A, b; c) where A = 5

Expected:   ==================================================
"""
f(a, b; c) where A

DOCSTRING

#Arguments:
- `a`: DESCRIPTION
- `b`: DESCRIPTION
- `c`: DESCRIPTION
"""
f(a::A, b; c) where A = 5

[ Info: Saved a backup to /tmp/jl_5P5joF/backup
[ Info: Saved a backup to /tmp/jl_upAgW0/backup
[ Info: Saved a backup to /tmp/jl_xU9Rxr/backup
[ Info: Saved a backup to /tmp/jl_yQXeRS/backup
   Testing AutomaticDocstrings tests passed