You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
I was quite puzzled to find out, that comments between docstrings and the documented objects are disallowed. As where @pfitzseb and @simeonschaub in JuliaDebug/JuliaInterpreter.jl/issues/538. This is actually the documented behavior and was discussed some time ago. But besides @JeffBezanson’s argument, that “it would be pretty confusing if a string still acted as a doc string despite any number of intervening blank and comment lines” the discussion did not cover the point of comments between doc string and documented object.
"The great foo"#TODO: Implement this properly.
foo =42
Here "The great foo" does nothing at all. So I wonder, whether code, that does nothing but has a chance to have been intended to do something (document foo) could perhaps throw a warning? That could help confused people like me, to find out, what they did wrong.
The text was updated successfully, but these errors were encountered:
I was quite puzzled to find out, that comments between docstrings and the documented objects are disallowed. As where @pfitzseb and @simeonschaub in JuliaDebug/JuliaInterpreter.jl/issues/538. This is actually the documented behavior and was discussed some time ago. But besides @JeffBezanson’s argument, that “it would be pretty confusing if a string still acted as a doc string despite any number of intervening blank and comment lines” the discussion did not cover the point of comments between doc string and documented object.
Here
"The great foo"
does nothing at all. So I wonder, whether code, that does nothing but has a chance to have been intended to do something (documentfoo
) could perhaps throw a warning? That could help confused people like me, to find out, what they did wrong.The text was updated successfully, but these errors were encountered: