# Custom docs do not show up in VSCode browser

**URL:** <https://discourse.julialang.org/t/custom-docs-do-not-show-up-in-vscode-browser/79449>\
**Category:** General Usage\
**Tags:** vscode\
**Created:** [April 13, 2022, 6:44pm UTC](https://discourse.julialang.org/t/custom-docs-do-not-show-up-in-vscode-browser/79449 "2022-04-13T18:44:43Z")\
**Posts on this page:** 10\
**Page:** 1

<div class="post-metadata">

**Author:** ![Christopher\_Fisher](https://sea2.discourse-cdn.com/julialang/user_avatar/discourse.julialang.org/christopher_fisher/32/26132_2.png) [@Christopher\_Fisher](https://discourse.julialang.org/u/Christopher_Fisher)\
**Post date:** [April 13, 2022, 6:44pm UTC](https://discourse.julialang.org/t/custom-docs-do-not-show-up-in-vscode-browser/79449/1 "2022-04-13T18:44:43Z")

</div>

I noticed that documentation for custom functions does not show up in my VSCode documentation broswser. The following does not work if executed in the REPL

“”"

Here’s some inline maths: `\\sqrt[n]{1 + x + x^2 + \\ldots}`.

Here’s an equation:

```julia
``\\frac{n!}{k!(n - k)!} = \\binom{n}{k}``

This is the binomial coefficient.

"""

func(x) = ()# ...

```

However if I add Distributions to the session, `Normal` will show up. Is there a way to allow my documentation appear in the documentation browswer?

Thanks!

---

<div class="post-metadata">

**Author:** ![jd-foster](https://sea2.discourse-cdn.com/julialang/user_avatar/discourse.julialang.org/jd-foster/32/35824_2.png) [@jd-foster](https://discourse.julialang.org/u/jd-foster)\
**Post date:** [April 14, 2022, 6:55am UTC](https://discourse.julialang.org/t/custom-docs-do-not-show-up-in-vscode-browser/79449/2 "2022-04-14T06:55:58Z")

</div>

> [@Christopher\_Fisher](#):
>
> Normal

Is this meant to be the same as your `func`?  
Are you defining this function in a module first before directly entering it in REPL?

---

<div class="post-metadata">

**Author:** ![Christopher\_Fisher](https://sea2.discourse-cdn.com/julialang/user_avatar/discourse.julialang.org/christopher_fisher/32/26132_2.png) [@Christopher\_Fisher](https://discourse.julialang.org/u/Christopher_Fisher)\
**Post date:** [April 14, 2022, 8:59am UTC](https://discourse.julialang.org/t/custom-docs-do-not-show-up-in-vscode-browser/79449/3 "2022-04-14T08:59:32Z")

</div>

Hello.

`Normal` is the normal distribution object from Distributions.jl. That works. However, the following do not work: entering a function in the REPL, entering a function wrapped in a module into the REPL, and loading a package I made.

It makes me wonder if there is an “update docs” function somewhere.

---

<div class="post-metadata">

**Author:** ![jd-foster](https://sea2.discourse-cdn.com/julialang/user_avatar/discourse.julialang.org/jd-foster/32/35824_2.png) [@jd-foster](https://discourse.julialang.org/u/jd-foster)\
**Post date:** [April 14, 2022, 9:00am UTC](https://discourse.julialang.org/t/custom-docs-do-not-show-up-in-vscode-browser/79449/4 "2022-04-14T09:00:38Z")

</div>

Are you using the `Revise.jl` Package in your workflow?

---

<div class="post-metadata">

**Author:** ![pfitzseb](https://sea2.discourse-cdn.com/julialang/user_avatar/discourse.julialang.org/pfitzseb/32/45566_2.png) [@pfitzseb](https://discourse.julialang.org/u/pfitzseb)\
**Post date:** [April 14, 2022, 9:02am UTC](https://discourse.julialang.org/t/custom-docs-do-not-show-up-in-vscode-browser/79449/5 "2022-04-14T09:02:45Z")

</div>

The docs pane (like almost all functionality) is based on the editor/project state, not the runtime state, so that’s basically expected.

---

<div class="post-metadata">

**Author:** ![Christopher\_Fisher](https://sea2.discourse-cdn.com/julialang/user_avatar/discourse.julialang.org/christopher_fisher/32/26132_2.png) [@Christopher\_Fisher](https://discourse.julialang.org/u/Christopher_Fisher)\
**Post date:** [April 14, 2022, 9:04am UTC](https://discourse.julialang.org/t/custom-docs-do-not-show-up-in-vscode-browser/79449/6 "2022-04-14T09:04:51Z")

</div>

I tried with Revise.jl with no success. Strangely, `Normal` shows up even though Distributions has not been loaded.

@pfitzseb, could you please explain what you mean by edit/project state? Is that the “Julia env: …” at the bottom of the window?

---

<div class="post-metadata">

**Author:** ![pfitzseb](https://sea2.discourse-cdn.com/julialang/user_avatar/discourse.julialang.org/pfitzseb/32/45566_2.png) [@pfitzseb](https://discourse.julialang.org/u/pfitzseb)\
**Post date:** [April 14, 2022, 9:18am UTC](https://discourse.julialang.org/t/custom-docs-do-not-show-up-in-vscode-browser/79449/7 "2022-04-14T09:18:53Z")

</div>

The docs pane search _should_ look at all symbols in the environment and also all symbols defined in your local project’s code, but the latter part isn’t working correctly atm, I think. Runtime state (i.e. anything you do in the REPL) doesn’t matter at all though – you don’t even need to have a REPL session running to get docs.

---

<div class="post-metadata">

**Author:** ![Christopher\_Fisher](https://sea2.discourse-cdn.com/julialang/user_avatar/discourse.julialang.org/christopher_fisher/32/26132_2.png) [@Christopher\_Fisher](https://discourse.julialang.org/u/Christopher_Fisher)\
**Post date:** [April 14, 2022, 9:21am UTC](https://discourse.julialang.org/t/custom-docs-do-not-show-up-in-vscode-browser/79449/8 "2022-04-14T09:21:25Z")

</div>

Thanks for your explanation. Would you like me to open up an issue at Julia-VSCode?

---

<div class="post-metadata">

**Author:** ![pfitzseb](https://sea2.discourse-cdn.com/julialang/user_avatar/discourse.julialang.org/pfitzseb/32/45566_2.png) [@pfitzseb](https://discourse.julialang.org/u/pfitzseb)\
**Post date:** [April 14, 2022, 9:23am UTC](https://discourse.julialang.org/t/custom-docs-do-not-show-up-in-vscode-browser/79449/9 "2022-04-14T09:23:11Z")

</div>

I’m looking into it.

---

<div class="post-metadata">

**Author:** ![etorkia](https://sea2.discourse-cdn.com/julialang/user_avatar/discourse.julialang.org/etorkia/32/11677_2.png) [@etorkia](https://discourse.julialang.org/u/etorkia)\
**Post date:** [August 19, 2022, 5:39pm UTC](https://discourse.julialang.org/t/custom-docs-do-not-show-up-in-vscode-browser/79449/10 "2022-08-19T17:39:33Z")

</div>

Why do some packages load into the documentation pane and others do not? In the REPL, the documentation for MCHammer.jl works but does not exist in the eyes of VScode. Any thoughts? Is there something in the package itself preventing the doc from rendering?