Documenting a struct

General Usage
1

I was surprised to find that the Julia documentation style guide says nothing about documenting structs. Is this something just not done? If it is done, does anyone have advice about best practices?

1 Like
2

Well there is a small section.

https://docs.julialang.org/en/v1/manual/documentation/#Types

You may be interested in the package DocStringExtensions.jl, which is perhaps best explained by example:

3 Likes
3

Ah. Under “Types.” I missed that. Thank you.

1 Like