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

Broadcast.broadcasted docstring indicates that it is a private function, but documentation treats it otherwise #56530

Open
brainandforce opened this issue Nov 11, 2024 · 2 comments

Comments

@brainandforce
Copy link

The Julia manual explicitly notes that Base.Broadcast.broadcasted(f, args...) should be implemented when customizing the default behavior of broadcasting, but when the docstring is pulled up with REPL help, it mentions that the symbol is private:

help?> Base.Broadcast.broadcasted
  │ Warning
  │
  │  The following bindings may be internal; they may change or be removed in future
  │  versions:
  │
  │    •  Base.Broadcast.broadcasted

  No documentation found for private symbol.

  Base.Broadcast.broadcasted is a Function.

  # 66 methods for generic function "broadcasted" from Base.Broadcast:
...

This is on Julia 1.11:

julia> versioninfo()
Julia Version 1.11.1
Commit 8f5b7ca12ad (2024-10-16 10:53 UTC)
Build Info:
  Official https://julialang.org/ release
Platform Info:
  OS: Linux (x86_64-linux-gnu)
  CPU: 8 × Intel(R) Core(TM) i7-1065G7 CPU @ 1.30GHz
  WORD_SIZE: 64
  LLVM: libLLVM-16.0.6 (ORCJIT, icelake-client)
Threads: 1 default, 0 interactive, 1 GC (on 8 virtual cores)
@jakobjpeters
Copy link
Contributor

Same with Broadcast.instantiate.

@mcabbott
Copy link
Contributor

Xref #51335, although broadcasted probably also wants a docstring.

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

3 participants