search

jonniedie / ConcreteStructs.jl

🏩🏠🌆🏨🌇🏦
MIT License
79 stars 2 forks source link

Documenting `@concrete` structs #11

Open ParadaCarleton opened 2 years ago

ParadaCarleton commented 2 years ago 
"""
    Object

Parameters:

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

This throws an error:

'@concrete' not documentable. See 'Base.@__doc__' docs for details.
jonniedie commented 2 years ago

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

jonniedie commented 2 years ago

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.

mrazomej commented 4 months ago

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