Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Confusing docstring #106

Open
mcabbott opened this issue Jan 8, 2025 · 1 comment
Open

Confusing docstring #106

mcabbott opened this issue Jan 8, 2025 · 1 comment

Comments

@mcabbott
Copy link

mcabbott commented Jan 8, 2025

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.)

@tecosaur
Copy link
Collaborator

Ah yep, that's a good call. I'll put a StyledStrings. in there shortly, and leave this issue open till I (or someone else) has checked for any similar cases.

Thanks for pointing this out!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants