# Updating a (still) private project to Julia 0.7/1.0

**URL:** <https://discourse.julialang.org/t/updating-a-still-private-project-to-julia-0-7-1-0/13824>\
**Category:** General Usage\
**Created:** [August 21, 2018, 12:29pm UTC](https://discourse.julialang.org/t/updating-a-still-private-project-to-julia-0-7-1-0/13824 "2018-08-21T12:29:57Z")\
**Posts on this page:** 13\
**Page:** 1

<div class="post-metadata">

**Author:** ![kellertuer](https://sea2.discourse-cdn.com/julialang/user_avatar/discourse.julialang.org/kellertuer/32/220707_2.png) [@kellertuer](https://discourse.julialang.org/u/kellertuer)\
**Post date:** [August 21, 2018, 12:29pm UTC](https://discourse.julialang.org/t/updating-a-still-private-project-to-julia-0-7-1-0/13824/1 "2018-08-21T12:29:57Z")

</div>

I was a little slow on my package development and would like to upgrade these days from 0.6 to 0.7; I am still trying to get it properly working and have two problems that I looked for today for the last hour

1. I started with `Pkg3` and did

```julia
develop ~/myPackage.jl/

```

that I worked on for some time and that uses (as kind of only dependency `SimpleTraits`.  
Now when doing `using myPackage` in REPL I get

```julia
┌ Warning: Package Manopt does not have SimpleTraits in its dependencies:
│ - If you have myPackage checked out for development and have
│ added SimpleTraits as a dependency but haven't updated your primary
│ environment's manifest file, try `Pkg.resolve()`.
│ - Otherwise you may need to report an issue with Manopt
└ Loading SimpleTraits into Manopt from project dependency, future warnings for Manopt are suppressed.

```

But Pkg.resove does not change anything, and I could not figure out how to add that as a dependency (just `add SimpleTraits` in `pkg>`did not do the Job, that was the only thing I could find)…  
Hot do I permanently and consistently add this dependency?

1. I have a lot of documentation using LaTeX since some of my documentation is easier to describe using formulae. Something like

```julia
    doc"""
    A documentation containing for example LateX like $\mathcal M$ to keep global information on a specific manifold
    """

```

worked fine in Julia 0.6 and I used it a lot.

Not in Julia 0.7 I get the deprecation warning

```julia
Deprecated syntax `doc" "` at /Users/bergmann/Repositories/Software/Manopt.jl/src/manifolds/Manifold.jl:17.
│ Use `@doc doc" "` instead.

```

But If I replace `doc`with `@doc doc` in the first line above (that’s how I understand that message) I get

```julia
WARNING: importing deprecated binding Base.@doc_str into MyPackage.
WARNING: Base.@doc_str is deprecated, use `Markdown` instead
  likely near /Users/bergmann/Repositories/Software/Manopt.jl/src/manifolds/Manifold.jl:14
ERROR: LoadError: LoadError: syntax: invalid interpolation syntax: "$ "

```

So it does not like my `$` anymore and I haven’t found any documentation how to solve that. Why do I want to use $? Well that makes it easy to copy a few explaning formulae from my original markdown and latex files describing the theory in papers/talks. So: How can I keep the format of my docstrings?

---

<div class="post-metadata">

**Author:** ![tobias.knopp](https://sea2.discourse-cdn.com/julialang/user_avatar/discourse.julialang.org/tobias.knopp/32/7551_2.png) [@tobias.knopp](https://discourse.julialang.org/u/tobias.knopp)\
**Post date:** [August 21, 2018, 1:01pm UTC](https://discourse.julialang.org/t/updating-a-still-private-project-to-julia-0-7-1-0/13824/2 "2018-08-21T13:01:02Z")

</div>

> [@kellertuer](#):
>
> Hot do I permanently and consistently add this dependency?

Do you have `SimpleTraits` in your REQUIRE file? If you do that and resolve afterwards, the issue will go away.

---

<div class="post-metadata">

**Author:** ![kellertuer](https://sea2.discourse-cdn.com/julialang/user_avatar/discourse.julialang.org/kellertuer/32/220707_2.png) [@kellertuer](https://discourse.julialang.org/u/kellertuer)\
**Post date:** [August 21, 2018, 1:10pm UTC](https://discourse.julialang.org/t/updating-a-still-private-project-to-julia-0-7-1-0/13824/3 "2018-08-21T13:10:46Z")

</div>

Thanks, Haven’t found that in the documentation.

---

<div class="post-metadata">

**Author:** ![tobias.knopp](https://sea2.discourse-cdn.com/julialang/user_avatar/discourse.julialang.org/tobias.knopp/32/7551_2.png) [@tobias.knopp](https://discourse.julialang.org/u/tobias.knopp)\
**Post date:** [August 21, 2018, 1:18pm UTC](https://discourse.julialang.org/t/updating-a-still-private-project-to-julia-0-7-1-0/13824/4 "2018-08-21T13:18:47Z")

</div>

yea, the current process is only documented in this forum. Once REQUIRE is obsolete the process will hopefully get more clear.

---

<div class="post-metadata">

**Author:** ![tobias.knopp](https://sea2.discourse-cdn.com/julialang/user_avatar/discourse.julialang.org/tobias.knopp/32/7551_2.png) [@tobias.knopp](https://discourse.julialang.org/u/tobias.knopp)\
**Post date:** [August 21, 2018, 1:41pm UTC](https://discourse.julialang.org/t/updating-a-still-private-project-to-julia-0-7-1-0/13824/5 "2018-08-21T13:41:59Z")

</div>

> [@kellertuer](#):
>
> So it does not like my `$` anymore and I haven’t found any documentation how to solve that. Why do I want to use $? Well that makes it easy to copy a few explaning formulae from my original markdown and latex files describing the theory in papers/talks. So: How can I keep the format of my docstrings?

you can quote the dollar sign `\$` but I am not sure if this is what you want. The doc then does not render the latex code.

---

<div class="post-metadata">

**Author:** ![kellertuer](https://sea2.discourse-cdn.com/julialang/user_avatar/discourse.julialang.org/kellertuer/32/220707_2.png) [@kellertuer](https://discourse.julialang.org/u/kellertuer)\
**Post date:** [August 21, 2018, 1:43pm UTC](https://discourse.julialang.org/t/updating-a-still-private-project-to-julia-0-7-1-0/13824/6 "2018-08-21T13:43:55Z")

</div>

Yes, but I’d also have to escape every latex commands `\`to `\\`and instead of that I could also use the Julia-style-mardkown ``` ``` to encapsulate LaTeX without escaping commands – that would all still mean to change the text. That’s what I liked about `doc"""..."""`

---

<div class="post-metadata">

**Author:** ![saschatimme](https://sea2.discourse-cdn.com/julialang/user_avatar/discourse.julialang.org/saschatimme/32/10313_2.png) [@saschatimme](https://discourse.julialang.org/u/saschatimme)\
**Post date:** [August 21, 2018, 1:50pm UTC](https://discourse.julialang.org/t/updating-a-still-private-project-to-julia-0-7-1-0/13824/7 "2018-08-21T13:50:04Z")

</div>

> [@kellertuer](#):
>
> But If I replace `doc` with `@doc doc` in the first line above (that’s how I understand that message) I get
> 
> ```julia-auto
> WARNING: importing deprecated binding Base.@doc_str into MyPackage.
> WARNING: Base.@doc_str is deprecated, use `Markdown` instead
> likely near /Users/bergmann/Repositories/Software/Manopt.jl/src/manifolds/Manifold.jl:14
> ERROR: LoadError: LoadError: syntax: invalid interpolation syntax: "$ "
> 
> ```
> 
> So it does not like my `$` anymore and I haven’t found any documentation how to solve that. Why do I want to use $? Well that makes it easy to copy a few explaning formulae from my original markdown and latex files describing the theory in papers/talks. So: How can I keep the format of my docstrings?

Did you try to add `using Markdown` to your imports?

---

<div class="post-metadata">

**Author:** ![tobias.knopp](https://sea2.discourse-cdn.com/julialang/user_avatar/discourse.julialang.org/tobias.knopp/32/7551_2.png) [@tobias.knopp](https://discourse.julialang.org/u/tobias.knopp)\
**Post date:** [August 21, 2018, 1:50pm UTC](https://discourse.julialang.org/t/updating-a-still-private-project-to-julia-0-7-1-0/13824/8 "2018-08-21T13:50:17Z")

</div>

> [@how can i use latex in julia v1.0](https://discourse.julialang.org/t/how-can-i-use-latex-in-julia-v1-0/13340):
>
> i want to write in latex a title in a plot so title("(Omega\_d )^2 " i try to use \Omega and press tab to choose the greek letter … but the subscript \_d i can not julia v1.0 do not accept L"\Omega\_d" any ideas ?

---

<div class="post-metadata">

**Author:** ![kellertuer](https://sea2.discourse-cdn.com/julialang/user_avatar/discourse.julialang.org/kellertuer/32/220707_2.png) [@kellertuer](https://discourse.julialang.org/u/kellertuer)\
**Post date:** [August 21, 2018, 1:52pm UTC](https://discourse.julialang.org/t/updating-a-still-private-project-to-julia-0-7-1-0/13824/9 "2018-08-21T13:52:15Z")

</div>

Haven’t heard of it and did not understand the deprecation warning that way; Does that package directly interpreted strings as Markdown then?

---

<div class="post-metadata">

**Author:** ![saschatimme](https://sea2.discourse-cdn.com/julialang/user_avatar/discourse.julialang.org/saschatimme/32/10313_2.png) [@saschatimme](https://discourse.julialang.org/u/saschatimme)\
**Post date:** [August 21, 2018, 1:58pm UTC](https://discourse.julialang.org/t/updating-a-still-private-project-to-julia-0-7-1-0/13824/10 "2018-08-21T13:58:35Z")

</div>

Markdown is one of the standard library packages and it seems that the function is now defined there

> <https://github.com/JuliaLang/julia/blob/4498d27c3c3e11effdfdfdce822d025079f01a0a/stdlib/Markdown/src/Markdown.jl#L45>

I don’t use this personally, but other packages seem to use this now this way:

> <https://github.com/Nemocas/AbstractAlgebra.jl/blob/09ae82a1546c43ed1870d79e807a05ae63177805/src/julia/Integer.jl#L43>

---

<div class="post-metadata">

**Author:** ![kellertuer](https://sea2.discourse-cdn.com/julialang/user_avatar/discourse.julialang.org/kellertuer/32/220707_2.png) [@kellertuer](https://discourse.julialang.org/u/kellertuer)\
**Post date:** [August 21, 2018, 2:00pm UTC](https://discourse.julialang.org/t/updating-a-still-private-project-to-julia-0-7-1-0/13824/11 "2018-08-21T14:00:20Z")

</div>

Thanks, that looks neat, couldn’t find that notation in the Markdown package. I will try to use it when I get my Atom back to accepting Julia. It just decided to automatically update to the Julia-Atom 0.17.0 that now crashes Julia on start -.-

---

<div class="post-metadata">

**Author:** ![kellertuer](https://sea2.discourse-cdn.com/julialang/user_avatar/discourse.julialang.org/kellertuer/32/220707_2.png) [@kellertuer](https://discourse.julialang.org/u/kellertuer)\
**Post date:** [August 21, 2018, 2:29pm UTC](https://discourse.julialang.org/t/updating-a-still-private-project-to-julia-0-7-1-0/13824/12 "2018-08-21T14:29:47Z")

</div>

So, I tested the `Markdown.doc` idea – it does compile fine (already on Julia 1.0 since I resolved all deprecation warnings) – but while all non-Markdown strings nicely show up in `?FctName` a `FctWithMarkdown`function just yields `no documentation found`.

---

<div class="post-metadata">

**Author:** ![kellertuer](https://sea2.discourse-cdn.com/julialang/user_avatar/discourse.julialang.org/kellertuer/32/220707_2.png) [@kellertuer](https://discourse.julialang.org/u/kellertuer)\
**Post date:** [August 21, 2018, 4:53pm UTC](https://discourse.julialang.org/t/updating-a-still-private-project-to-julia-0-7-1-0/13824/13 "2018-08-21T16:53:56Z")

</div>

While somehow neither `md"""` nor `Markdown.doc"""`does seem to work on Julia 0.7, after I fixed all other Deprecation warnings now the tip of using `@doc doc"""`actually _does_ work; I am just not sure why it did not in the first place.
