# How to Put Sublists into Docstrings?

**URL:** https://discourse.julialang.org/t/how-to-put-sublists-into-docstrings/57843
**Category:** General Usage
**Tags:** package, documentation
**Created:** [March 24, 2021, 3:49am UTC](https://discourse.julialang.org/t/how-to-put-sublists-into-docstrings/57843 "2021-03-24T03:49:31Z")
**Posts on this page:** 6
**Page:** 1

<div class="post-metadata">

### Author: ![TheCedarPrince](https://sea2.discourse-cdn.com/julialang/user_avatar/discourse.julialang.org/thecedarprince/32/17323_2.png) [@TheCedarPrince](https://discourse.julialang.org/u/TheCedarPrince)
#### Post date: [March 24, 2021, 3:49am UTC](https://discourse.julialang.org/t/how-to-put-sublists-into-docstrings/57843/1 "2021-03-24T03:49:31Z")

</div>

Hi all,

I was reviewing a PR recently and was trying to correct a small error in their docstring. Here is the docstring:

```julia
"""
    latex(text::LaTeXString, pos::Point, object::Symbol; valign::Symbol = :top, halign::Symbol = :left)

Add the latex string `text` to the top left corner of the LaTeX path.
Can be added to `Luxor.jl` graphics via [`Video`](@ref).

**NOTES:**
- **This only works if `tex2svg` is installed.**
    It can be installed using the following command (you may have to prefix this command with `sudo` depending on your installation):

        npm install -g mathjax-node-cli

- **The `latex` method must be called from within an [`Object`](@ref).**

# Arguments
- `text::LaTeXString`: a LaTeX string to render.
- `pos::Point`: position of the upper left corner of the latex text. Default: `O`
    - can be written as `x, y` instead of `Point(x, y)`
- `object::Symbol`: graphics objects defined by `Luxor.jl`. Default `:stroke`.
	- `:stroke` - Draws the latex string on the canvas. For more info check `Luxor.strokepath`
	- `:path` - Creates the path of the latex string but does not render it to the canvas.

```

What I was expecting by creating sublists in the Arguments section, the bullets would be indented neatly like this:

* * *

# Arguments

- `text::LaTeXString`: a LaTeX string to render.
- `pos::Point`: position of the upper left corner of the latex text. Default: `O`
  - can be written as `x, y` instead of `Point(x, y)`

- `object::Symbol`: graphics objects defined by `Luxor.jl`. Default `:stroke`.
  - `:stroke` - Draws the latex string on the canvas. For more info check `Luxor.strokepath`
  - `:path` - Creates the path of the latex string but does not render it to the canvas.

* * *

Instead, the rendered docstring looks like this:

 ![image](https://global.discourse-cdn.com/julialang/original/3X/9/7/97cac3fca7a9c067a61fafd6ded32b3295b26362.png)

As one can see, the bullet for `pos` now contains the sub-bullet and the `stroke` and `path` sub-bullets were not rendered. Could anyone explain or help me figure out why this Markdown syntax does not work in docstrings?

Thank you!

~ tcp 🌳

---

<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: [March 24, 2021, 7:23am UTC](https://discourse.julialang.org/t/how-to-put-sublists-into-docstrings/57843/2 "2021-03-24T07:23:12Z")

</div>

This looks like a bug. If you don’t get a reply here, please check existing issues and open one if necessary.

---

<div class="post-metadata">

### Author: ![fredrikekre](https://sea2.discourse-cdn.com/julialang/user_avatar/discourse.julialang.org/fredrikekre/32/1688_2.png) [@fredrikekre](https://discourse.julialang.org/u/fredrikekre)
#### Post date: [March 24, 2021, 9:49am UTC](https://discourse.julialang.org/t/how-to-put-sublists-into-docstrings/57843/3 "2021-03-24T09:49:14Z")

</div>

What Julia version are you using? It works as expected on Julia 1.5. (Julia 1.6 has another list display bug, but it does not look as in your screenshot).

---

<div class="post-metadata">

### Author: ![Xijiang\_Yu](https://sea2.discourse-cdn.com/julialang/user_avatar/discourse.julialang.org/xijiang_yu/32/14439_2.png) [@Xijiang\_Yu](https://discourse.julialang.org/u/Xijiang_Yu)
#### Post date: [March 24, 2021, 10:23am UTC](https://discourse.julialang.org/t/how-to-put-sublists-into-docstrings/57843/4 "2021-03-24T10:23:11Z")

</div>

I use 0-day julia. Same problem.

---

<div class="post-metadata">

### Author: ![TheCedarPrince](https://sea2.discourse-cdn.com/julialang/user_avatar/discourse.julialang.org/thecedarprince/32/17323_2.png) [@TheCedarPrince](https://discourse.julialang.org/u/TheCedarPrince)
#### Post date: [March 24, 2021, 1:04pm UTC](https://discourse.julialang.org/t/how-to-put-sublists-into-docstrings/57843/5 "2021-03-24T13:04:54Z")

</div>

Ah that might be it then - I am using Julia 1.6.0-rc3. I’ll look to see if an issue is opened on Julia

---

<div class="post-metadata">

### Author: ![TheCedarPrince](https://sea2.discourse-cdn.com/julialang/user_avatar/discourse.julialang.org/thecedarprince/32/17323_2.png) [@TheCedarPrince](https://discourse.julialang.org/u/TheCedarPrince)
#### Post date: [March 24, 2021, 2:36pm UTC](https://discourse.julialang.org/t/how-to-put-sublists-into-docstrings/57843/6 "2021-03-24T14:36:41Z")

</div>

Issue opened since I could not find anything else referencing this phenomena: [https://github.com/JuliaLang/julia/issues/40169](https://github.com/JuliaLang/julia/issues/40169)
