""" changed to ``` in installed package preventing documentation build

Mark_Nahabedian · June 24, 2022, 4:23pm

In my repo, documentation strings are wrapped in tripple double-quotes:

MarkNahabedian/NahaJuliaLib.jl/blob/541a15f287158e7e09fda1eb515f4dc386c05eb5/src/properties.jl#L12


      
          # being queried by `getproperty`, we can method specialize on Val types.
          # We should then be able to automate `propertynames` based on the
          # defined methods.
          
          
# A struct might have fields, which are exposed as properties.  The
          # `Val` methods will not shadow the method that implements that.
          
          
export @njl_getprop
          
          

          
"""
              propertynames_from_val_methods(t::Type, private::Bool)
          Compute and return the `propertynames` for type `t` from
          its fields and `Val` specialized methods.
          """
          function propertynames_from_val_methods(t::Type, private::Bool)
              props = collect(fieldnames(t))
              for m in methods(Base.getproperty, [t, Any]).ms
                  if m.sig isa DataType
                      if m.sig.parameters[2] == t
                          p = m.sig.parameters[3]

julia make.jl 
  Activating project at `c:\Users\Mark Nahabedian\NahaJuliaLib.jl\docs`
ERROR: LoadError: parsing command `    propertynames_from_val_methods(t::Type, private::Bool)
Compute and return the `propertynames` for type `t` from
its fields and `Val` specialized methods.
`: special characters "#{}()[]<>|&*?~;" must be quoted in commands
Stacktrace:
  [1] error(s::String)
    @ Base .\error.jl:33
  [2] shell_parse(str::String, interpolate::Bool; special::String, filename::String)
    @ Base .\shell.jl:114
  [3] var"@cmd"(__source__::LineNumberNode, __module__::Module, str::Any)
    @ Base .\cmd.jl:442
  [4] include(mod::Module, _path::String)
    @ Base .\Base.jl:418
  [5] include(x::String)
    @ NahaJuliaLib C:\Users\Mark Nahabedian\.julia\packages\NahaJuliaLib\eazFw\src\NahaJuliaLib.jl:1
  [6] top-level scope
    @ C:\Users\Mark Nahabedian\.julia\packages\NahaJuliaLib\eazFw\src\NahaJuliaLib.jl:5
  [7] include
    @ .\Base.jl:418 [inlined]
  [8] include_package_for_output(pkg::Base.PkgId, input::String, depot_path::Vector{String}, dl_load_path::Vector{String}, load_path::Vector{String}, concrete_deps::Vector{Pair{Base.PkgId, UInt64}}, source::String)
    @ Base .\loading.jl:1318
  [9] top-level scope
    @ none:1
 [10] eval
    @ .\boot.jl:373 [inlined]
 [11] eval(x::Expr)
    @ Base.MainInclude .\client.jl:453
 [12] top-level scope
    @ none:1
in expression starting at C:\Users\Mark Nahabedian\.julia\packages\NahaJuliaLib\eazFw\src\properties.jl:11
in expression starting at C:\Users\Mark Nahabedian\.julia\packages\NahaJuliaLib\eazFw\src\properties.jl:11
in expression starting at C:\Users\Mark Nahabedian\.julia\packages\NahaJuliaLib\eazFw\src\NahaJuliaLib.jl:1

If I look at the installed file, C:\Users\Mark Nahabedian.julia\packages\NahaJuliaLib\eazFw\src\properties.jl:11, I find that those double quotes have been replaced with backquotes – causing the failure of my docs build.

How/why did this happen, and how do I fix it?

cormullion · June 24, 2022, 6:15pm

That’s a peculiar error - I can’t reproduce it here (on MacOS), as the docs build OK. There’s a small issue with an unclosed backquote:

which you can see in the line where “of” and “will find” have been highlighted by mistake. I don’t think this is the cause of your error though.