# Docstring linting (e.g., check for missing argument descriptions in the docstring)

**URL:** https://discourse.julialang.org/t/docstring-linting-e-g-check-for-missing-argument-descriptions-in-the-docstring/102237
**Category:** Tooling
**Tags:** documentation, lint, ci, markdown, docstring
**Created:** [July 29, 2023, 12:48pm UTC](https://discourse.julialang.org/t/docstring-linting-e-g-check-for-missing-argument-descriptions-in-the-docstring/102237 "2023-07-29T12:48:02Z")
**Posts on this page:** 4
**Page:** 1

<div class="post-metadata">

### Author: ![abelsiqueira](https://sea2.discourse-cdn.com/julialang/user_avatar/discourse.julialang.org/abelsiqueira/32/47269_2.png) [@abelsiqueira](https://discourse.julialang.org/u/abelsiqueira)
#### Post date: [July 29, 2023, 12:48pm UTC](https://discourse.julialang.org/t/docstring-linting-e-g-check-for-missing-argument-descriptions-in-the-docstring/102237/1 "2023-07-29T12:48:02Z")

</div>

Is there a package for linting the docstrings?  
I am looking for something like pydocstyle, but something that just checks that the arguments in the function signature are included in the docstring is already valuable.

---

<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: [July 29, 2023, 1:08pm UTC](https://discourse.julialang.org/t/docstring-linting-e-g-check-for-missing-argument-descriptions-in-the-docstring/102237/2 "2023-07-29T13:08:00Z")

</div>

I have a package in the works for this called `CheckDoc.jl`, which does this and a bit more — the current holdup is that parsing docstring function signature pseudo-code and matching it up with the methods that exist is not straightforward.

---

<div class="post-metadata">

### Author: ![abelsiqueira](https://sea2.discourse-cdn.com/julialang/user_avatar/discourse.julialang.org/abelsiqueira/32/47269_2.png) [@abelsiqueira](https://discourse.julialang.org/u/abelsiqueira)
#### Post date: [July 31, 2023, 7:58pm UTC](https://discourse.julialang.org/t/docstring-linting-e-g-check-for-missing-argument-descriptions-in-the-docstring/102237/3 "2023-07-31T19:58:55Z")

</div>

Thanks for replying. Please post it here when you make it public.  
After Julia 1.10, it might be possible to reuse some parts of Documenter.jl and MarkdownAST.jl to improve the parsing.

---

<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: [August 3, 2023, 12:45pm UTC](https://discourse.julialang.org/t/docstring-linting-e-g-check-for-missing-argument-descriptions-in-the-docstring/102237/4 "2023-08-03T12:45:17Z")

</div>

Oh, when I say “parsing” I don’t mean markdown, I mean stuff like this:

```julia
foo([base::Int=2], a => y; z...)

```