Consider the following function in a module CGP <

<a class="user-mention notranslate" data-hovercard-type="user" data-hovercard-url="/us

How to use alias of AbstractArray instead of the full name? (Feature request) about docstringextensions.jl HOT 2 CLOSED

juliadocs commented on June 24, 2024

How to use alias of AbstractArray instead of the full name? (Feature request)

from docstringextensions.jl.

Comments (2)

ShuhuaGao commented on June 24, 2024 1

@MichaelHatherly Noted with thanks. Currently, I am using 1.5, but will switch to 1.6 once it is released.

from docstringextensions.jl.

MichaelHatherly commented on June 24, 2024

Agreed, definitely a nice to have feature. If you're on Julia 1.6 or above this should just work out the box since TYPEDSIGNATURES hooks into the base display system for printing types, and printing of the type alias was added for 1.6:

               _
   _       _ _(_)_     |  Documentation: https://docs.julialang.org
  (_)     | (_) (_)    |
   _ _   _| |_  __ _   |  Type "?" for help, "]?" for Pkg help.
  | | | | | | |/ _` |  |
  | | |_| | | | (_| |  |  Version 1.6.0-beta1.91 (2021-02-02)
 _/ |\__'_|_|_|\__'_|  |  release-1.6/e02764ca43* (fork: 198 commits, 57 days)
|__/                   |

(@v1.6) pkg> add DocStringExtensions
    Updating registry at `~/.julia/registries/General`
    Updating registry at `~/.julia/registries/PumasRegistry`
   Resolving package versions...
    Updating `~/.julia/environments/v1.6/Project.toml`
  [ffbed154] + DocStringExtensions v0.8.3
  No Changes to `~/.julia/environments/v1.6/Manifest.toml`

julia> using DocStringExtensions

julia> """
       $(TYPEDSIGNATURES)
       """
       function f2(v::Vector{Int}, m::Matrix{Float64})
           return sum(v) + sum(m)
       end
f2

help?> f2
search: Float32 f2 Inf32 ComplexF32

  f2(v::Vector{Int64}, m::Matrix{Float64}) -> Float64

For 1.5 and below there's no general way to do this properly since it requires support in base Julia.

from docstringextensions.jl.

Recommend Projects