-
-
Notifications
You must be signed in to change notification settings - Fork 5.5k
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
don't warn about redefining docstrings in Main #23011
Comments
Looks like an easy patch should do it:
|
Or we could just delete the warning entirely. We already have a warning for redefining methods that are not in Main, and this seems somewhat redundant with that. |
I believe it's possible to replace docs without redefining the method, e.g. by just writing the function name (?). So the warning might still be useful. |
Yes that has happened to me several times, the warning about overwriting docs is very useful actually. |
I always edit functions in Juno and call them in IJulia to check the results. And then revise the code in Juno and "include()" the code file in IJulia again to check the results. In this situation, every time I saw a lot of warnings of redefining docstrings. When there are a lot of functions, the IJulia notebook is occupied by the warnings. Although this warning would be helpful in some other situations, it is still convenient for the users to suppress the warnings when they want. |
We definitely shouldn't have a warning for redefining docstrings in Main, at least, similar to #19888. Redefining things in interactive use is expected and shouldn't trigger warnings. |
Similar to #18725, it came up on discourse that we shouldn't emit a warning when redefining docstrings during interactive use, i.e. for definitions in
Main
:The text was updated successfully, but these errors were encountered: