Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Documenting @concrete structs #11

Open
ParadaCarleton opened this issue Nov 21, 2021 · 3 comments
Open

Documenting @concrete structs #11

ParadaCarleton opened this issue Nov 21, 2021 · 3 comments

Comments

@ParadaCarleton
Copy link

"""
    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
Copy link
Owner

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

@jonniedie
Copy link
Owner

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
Copy link

mrazomej commented Jul 7, 2024

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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

3 participants