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

Docstrings for module include and eval functions #52581

Open
jariji opened this issue Dec 18, 2023 · 4 comments
Open

Docstrings for module include and eval functions #52581

jariji opened this issue Dec 18, 2023 · 4 comments
Labels
docs This change adds or pertains to documentation

Comments

@jariji
Copy link
Contributor

jariji commented Dec 18, 2023

Most modules have an include and eval function. Can they be documented? They don't have to be public but it's nice for names to have documentation.

@jariji
Copy link
Contributor Author

jariji commented Dec 19, 2023

I mean should these get a docstring:

julia> module Foo end
Main.Foo

help?> Foo.eval
  No documentation found.

  Main.Foo.eval is a Function.

  # 1 method for generic function "eval" from Main.Foo:
   [1] eval(x)
       @ REPL[1]:1


help?> Foo.include
  No documentation found.

  Main.Foo.include is a Function.

  # 2 methods for generic function "include" from Main.Foo:
   [1] include(mapexpr::Function, x)
       @ REPL[1]:1
   [2] include(x)
       @ REPL[1]:1

@nsajko
Copy link
Contributor

nsajko commented Dec 19, 2023

Yeah that seems like a good idea. Maybe edit the issue title to include "doc string" somewhere in it.

@jariji jariji changed the title Document module include and eval functions Docstrings for module include and eval functions Dec 19, 2023
@stevengj
Copy link
Member

(Note that this issue arose in #52413.)

@stevengj stevengj added the docs This change adds or pertains to documentation label Jan 12, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs This change adds or pertains to documentation
Projects
None yet
Development

No branches or pull requests

3 participants