# Documenting a struct

**URL:** <https://discourse.julialang.org/t/documenting-a-struct/106773>\
**Category:** General Usage\
**Tags:** documentation\
**Created:** [November 26, 2023, 10:51pm UTC](https://discourse.julialang.org/t/documenting-a-struct/106773 "2023-11-26T22:51:59Z")\
**Posts on this page:** 3\
**Page:** 1

<div class="post-metadata">

**Author:** ![rmfritz](https://avatars.discourse-cdn.com/v4/letter/r/b487fb/32.png) [@rmfritz](https://discourse.julialang.org/u/rmfritz)\
**Post date:** [November 26, 2023, 10:51pm UTC](https://discourse.julialang.org/t/documenting-a-struct/106773/1 "2023-11-26T22:51:59Z")

</div>

I was surprised to find that the [Julia documentation style guide](https://docs.julialang.org/en/v1/manual/documentation/) says nothing about documenting structs. Is this something just not done? If it is done, does anyone have advice about best practices?

---

<div class="post-metadata">

**Author:** ![mkitti](https://sea2.discourse-cdn.com/julialang/user_avatar/discourse.julialang.org/mkitti/32/12459_2.png) [@mkitti](https://discourse.julialang.org/u/mkitti)\
**Post date:** [November 26, 2023, 11:14pm UTC](https://discourse.julialang.org/t/documenting-a-struct/106773/2 "2023-11-26T23:14:14Z")

</div>

Well there is a small section.

[https://docs.julialang.org/en/v1/manual/documentation/#Types](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:

> <https://github.com/JuliaDocs/DocStringExtensions.jl/blob/master/docs/Showcase/src/Showcase.jl#L127>

---

<div class="post-metadata">

**Author:** ![rmfritz](https://avatars.discourse-cdn.com/v4/letter/r/b487fb/32.png) [@rmfritz](https://discourse.julialang.org/u/rmfritz)\
**Post date:** [November 26, 2023, 11:28pm UTC](https://discourse.julialang.org/t/documenting-a-struct/106773/3 "2023-11-26T23:28:30Z")

</div>

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