Skip to content

Confusing docstring #106

@mcabbott

Description

@mcabbott

In the help for merge, you know, the function for concatenating NamedTuples, there's a confusing entry at the end:

help?> merge
search: merge merge! mergewith mergewith!

  merge(d::AbstractDict, others::AbstractDict...)

  Construct a merged collection from the given collections. If necessary, the types of the
  resulting collection will be promoted to accommodate the types of the merged collections. If the

[...]  ────────────────────────────────────────────────────────────────────────────────────────────────

  merge(a::NamedTuple, iterable)

  Interpret an iterable of key-value pairs as a named tuple, and perform a merge.

  julia> merge((a=1, b=2, c=3), [:b=>4, :d=>5])
  (a = 1, b = 4, c = 3, d = 5)

  ────────────────────────────────────────────────────────────────────────────────────────────────

  merge(initial::Face, others::Face...)

  Merge the properties of the initial face and others, with later faces taking priority.

julia> Face
ERROR: UndefVarError: `Face` not defined in `Main`

I think at least that should say StyledStrings.Face, and perhaps tell me what on earth "face" means here.

(Might be worth auditing for other equally confusing entries, too.)

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