# Documenting elements of a struct

**URL:** https://discourse.julialang.org/t/documenting-elements-of-a-struct/64769
**Category:** New to Julia
**Tags:** documenter, struct
**Created:** [July 16, 2021, 7:32pm UTC](https://discourse.julialang.org/t/documenting-elements-of-a-struct/64769 "2021-07-16T19:32:46Z")
**Posts on this page:** 1
**Showing post:** 33

<div class="post-metadata">

### Author: ![Tamas\_Papp](https://sea2.discourse-cdn.com/julialang/user_avatar/discourse.julialang.org/tamas_papp/32/25949_2.png) [@Tamas\_Papp](https://discourse.julialang.org/u/Tamas_Papp)
#### Post date: [July 19, 2021, 8:55am UTC](https://discourse.julialang.org/t/documenting-elements-of-a-struct/64769/33 "2021-07-19T08:55:54Z")

</div>

> [@DNF](#):
>
> For those who want fields as part of the API, by all means document them

I agree that struct fields should be considered implementation details unless specified otherwise, but I find that documenting things that are not part of the API is also useful. I docstring a lot of internal functions, type specs, and fields, so that when I come back to the code 2 years after I wrote it I can navigate it better. Also, this helps potential contributors.

---

_[View the full topic](https://discourse.julialang.org/t/documenting-elements-of-a-struct/64769)._