Skip to content

@doc defined methods are not shown without explicitly requesting them #2691

Open
@tecosaur

Description

@tecosaur

Hello!

I've run into a minor hiccup with the newly-developed docs for my Trash.jl package. To help with the cross-platform implementation, I have stubs with docstrings that in one file:

"""
    list() -> Vector{TrashFile}

List all entries currently in the user's trash.

See also: [`trash`](@ref), [`untrash`](@ref).
"""
function list end

@doc """
    list(trashdir::String) -> Vector{TrashFile}

List all entries currently in the trash directory `trashdir`.

See also: [`trashdir`](@ref), [`search`](@ref).
""" list(::String)

I then have @docs blocks as usual, e.g.

```@docs
Trash.list
...
```

But it seems that instead of showing all methods, only the first method is shown. I can get the second printed by adding Trash.list(::String), but other than the tedium I miss the way the docs for both methods are shown under a single function block.

I'm guessing this isn't the intended behaviour.

Metadata

Metadata

Assignees

No one assigned

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions