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.

Sign up for GitHub

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

Jump to bottom

Empty lines between docstrings and methods/structs #8

Closed

navidcy opened this issue Oct 20, 2024 · 1 comment

Contributor

navidcy commented Oct 20, 2024

There should be no empty line between the docstrings and the corresponding method/struct, e.g.,

QGDipoles.jl/src/QGDipoles.jl

Lines 6 to 8 in a1a7e12

    
           """ 
        
           module QGDipoles

See, e.g.,

"""
    f(x)

Return 2x.
"""

f(x) = 2x

"""
    g(x)

Return x^2.
"""
g(x) = x^2

help?> f
search: f if fd

  No documentation found for private symbol.

  f is a Function.

  # 1 method for generic function "f" from Main:
   [1] f(x)
       @ REPL[2]:1

help?> g
search: g

  g(x)

  Return x^2.

Owner

mncrowe commented Oct 29, 2024

Thanks, I believe this is now fixed, calling e.g. ? CreateGrid works as expected

mncrowe closed this as completed

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment