# Some thoughts on improving basic function documentation

**URL:** <https://discourse.julialang.org/t/some-thoughts-on-improving-basic-function-documentation/103546>\
**Category:** General Usage\
**Tags:** documentation\
**Created:** [September 5, 2023, 3:18pm UTC](https://discourse.julialang.org/t/some-thoughts-on-improving-basic-function-documentation/103546 "2023-09-05T15:18:56Z")\
**Posts on this page:** 1\
**Showing post:** 47

<div class="post-metadata">

**Author:** ![tecosaur](https://sea2.discourse-cdn.com/julialang/user_avatar/discourse.julialang.org/tecosaur/32/23206_2.png) [@tecosaur](https://discourse.julialang.org/u/tecosaur)\
**Post date:** [October 20, 2024, 3:27pm UTC](https://discourse.julialang.org/t/some-thoughts-on-improving-basic-function-documentation/103546/47 "2024-10-20T15:27:52Z")

</div>

> [@tecosaur](#):
>
> I really need to make my WIP `CheckDoc.jl` public, with the various kinks… documentation of error types that may be `throw`n is one of the checks I’ve implemented.
> 
> Perhaps if it’s public I could get help in solving some of the difficulties I’m having that have been (mentally) blocking me from making it public 😛

**Update:** [GitHub - tecosaur/CheckDoc.jl: Documentation linting](https://github.com/tecosaur/CheckDoc.jl/) is now public 😀 (though currently unregistered).

---

_[View the full topic](https://discourse.julialang.org/t/some-thoughts-on-improving-basic-function-documentation/103546)._