Skip to content

Help for "import" is not sufficient #59909

@ufechner7

Description

@ufechner7

The doc strings is too short:

help?> import
search: import export import_log isqrt ispow2 isperm insorted Cshort sort hypot

  import

  import Foo will load the module or package Foo. Names from the imported Foo
  module can be accessed with dot syntax (e.g. Foo.foo to access the name
  foo). See the manual section about modules for details.

julia>

The notation

import GLMakie as ma

for example, it is not mentioned at all. And the sentence “See manual section…” is missing a hyperlink.

Before creating a pull request, I would like to get your opinion: What is the way forward?

  • extending the docstring OR
  • adding a hyperlink that works OR
  • both

Julia 1.11 and Julia 1.12

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions