# \#docstring

**URL:** https://discourse.julialang.org/tag/docstring/1411.md

[Latest](https://discourse.julialang.org/latest.md) · [Categories](https://discourse.julialang.org/categories.md) · [Tags](https://discourse.julialang.org/tags.md)

---

## [Documenting nested functions](https://discourse.julialang.org/t/documenting-nested-functions/129708)

<div class="topic-metadata">

**Author:** [@maxwell3025](https://discourse.julialang.org/u/maxwell3025)\
**Replies:** 2\
**Last updated:** [June 9, 2025, 6:15am UTC](https://discourse.julialang.org/t/documenting-nested-functions/129708 "2025-06-09T06:15:53Z")

</div>

I’m currently working on a project and I came across an issue with using nested functions. In particular, I have a nested function that I want to document, and I am getting a warning about “replacing docs”. This seems …

---

## [Suggestion for package docstrings](https://discourse.julialang.org/t/suggestion-for-package-docstrings/123548)

<div class="topic-metadata">

**Author:** [@Eben60](https://discourse.julialang.org/u/Eben60)\
**Replies:** 3\
**Last updated:** [December 7, 2024, 6:29am UTC](https://discourse.julialang.org/t/suggestion-for-package-docstrings/123548 "2024-12-07T06:29:00Z")

</div>

""" Package MyPackage v$(pkgversion(MyPackage)) MyPackage does this and that, and this text can be the the same as the "About" on it's github page. Docs under https://mypackageauthor.github.io/MyPackage.jl/ $(isnot…

---

## [Incrementally creating docstrings](https://discourse.julialang.org/t/incrementally-creating-docstrings/122115)

<div class="topic-metadata">

**Author:** [@GHTaarn](https://discourse.julialang.org/u/GHTaarn)\
**Replies:** 0\
**Last updated:** [November 1, 2024, 7:56am UTC](https://discourse.julialang.org/t/incrementally-creating-docstrings/122115 "2024-11-01T07:56:35Z")

</div>

I am in a situation where I would like to construct a docstring piece by piece rather than doing it in just one statement. I tried: module A varname = 0 @doc "Apple" varname @doc "$(@doc varname) Orange" varname end bu…

---

## [Documenting identical methods: unexpected change to @doc in 1.11.0](https://discourse.julialang.org/t/documenting-identical-methods-unexpected-change-to-doc-in-1-11-0/121309)

<div class="topic-metadata">

**Author:** [@brainandforce](https://discourse.julialang.org/u/brainandforce)\
**Replies:** 2\
**Last updated:** [October 16, 2024, 9:14pm UTC](https://discourse.julialang.org/t/documenting-identical-methods-unexpected-change-to-doc-in-1-11-0/121309 "2024-10-16T21:14:05Z")

</div>

In CliffordNumbers.jl, Base.reverse implements the reverse operation on a Clifford number or indexing object (BitIndex). For convenience, I’ve also overloaded the adjoint operator '. Because the documentation for adjoin…

---

## [How to append the docstring of a type or function in the upstream package in a downstream package](https://discourse.julialang.org/t/how-to-append-the-docstring-of-a-type-or-function-in-the-upstream-package-in-a-downstream-package/113418)

<div class="topic-metadata">

**Author:** [@kimikage](https://discourse.julialang.org/u/kimikage)\
**Replies:** 2\
**Last updated:** [April 28, 2024, 9:41am UTC](https://discourse.julialang.org/t/how-to-append-the-docstring-of-a-type-or-function-in-the-upstream-package-in-a-downstream-package/113418 "2024-04-28T09:41:06Z")

</div>

As an example, consider developing a downstream package like SpecificFoo.jl using upstream packages which provide APIs like FooBase.jl/FooCore.jl. We can write a docstring for the method defined in the downstream packag…

---

## [Docstring linting (e.g., check for missing argument descriptions in the docstring)](https://discourse.julialang.org/t/docstring-linting-e-g-check-for-missing-argument-descriptions-in-the-docstring/102237)

<div class="topic-metadata">

**Author:** [@abelsiqueira](https://discourse.julialang.org/u/abelsiqueira)\
**Replies:** 3\
**Last updated:** [August 3, 2023, 12:45pm UTC](https://discourse.julialang.org/t/docstring-linting-e-g-check-for-missing-argument-descriptions-in-the-docstring/102237 "2023-08-03T12:45:17Z")

</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.