?Symbol help message gives info on constructor, not on type

[matbesancon]

Looking up help on a type should first explain what the type is and does before going into how to call the constructor. This is not the case for Symbol

?Symbol
  Symbol(x...) -> Symbol

  Create a Symbol by concatenating the string representations of the arguments
  together.

[fredrikekre]

The fix here is to add a docstring to the Symbol type.

[matbesancon]

We can't have docstrings for both type and constructor right? So it needs to be moved from Symbol(string) and edited

[fredrikekre]

We can't have docstrings for both type and constructor right?

Why not?

julia> struct Foo x end

julia> """
           Foo

       The type.
       """
       Foo
Foo

julia> """
           Foo(x)

       The constructor.
       """
       Foo(x)
Foo

help?> Foo

  Foo

  The type.

  ─────────────────────────────────────────────────────────────────────
  Foo(x)

  The constructor.

[matbesancon]

Oh ok my bad, always thought they were shown from one docstring only

…

On Fri, Aug 17, 2018, 09:41 Fredrik Ekre ***@***.***> wrote: We can't have docstrings for both type and constructor right? Why not? julia> struct Foo x end julia> """ Foo The type. """ Foo Foo julia> """ Foo(x) The constructor. """ Foo(x) Foo help?> Foo Foo The type. ───────────────────────────────────────────────────────────────────── Foo(x) The constructor. — You are receiving this because you authored the thread. Reply to this email directly, view it on GitHub <#28647 (comment)>, or mute the thread <https://github.com/notifications/unsubscribe-auth/AHRRsj85SCbaly2wWWSLBbdRFkkgo-roks5uRnOigaJpZM4V8alY> .

[nikunj-taneja]

I would like to contribute. How can I add the docstring?

[matbesancon]

The doc for Symbol is in base/docs/basedocs.jl line 1251