ConcreteStructs.jl icon indicating copy to clipboard operation
ConcreteStructs.jl copied to clipboard

Documenting `@concrete` structs

Open ParadaCarleton opened this issue 3 years ago β€’ 3 comments

"""
    Object

Parameters:

- `x`: Stores information.
"""
@concrete terse struct Object
    x
end

This throws an error:

'@concrete' not documentable. See 'Base.@__doc__' docs for details.

ParadaCarleton avatar Nov 21 '21 18:11 ParadaCarleton

Thanks for the issue. I’ll check out why this isn’t working.

jonniedie avatar Nov 21 '21 20:11 jonniedie

Hm. It seems that it only has a problem when the terse keyword is used. I'm actually not too sure how to debug this one at the moment. This is another good reason to start thinking about implementing #5.

jonniedie avatar Nov 21 '21 20:11 jonniedie

+1 on this request. Being able to document all @concrete structs would be fantastic.

mrazomej avatar Jul 07 '24 15:07 mrazomej