-
Notifications
You must be signed in to change notification settings - Fork 46
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
dyc diff
fails when removing docstrings from a method
#49
Comments
Hey @Zarad1993, I'm a first time contributor and would like to work on this. Could you please explain this issue a bit more? |
Hey @Abo7atm - Thank you so much for choosing this project 🙂 ! At a high level,
To reproduce: def hello_world():
"""
My docstrings
"""
return 'hello world'
Please let me know if further details are needed. |
I tried your example on my machine, and it seems that I read the method in the code that checks whether the method has been documented or not, and from what I understood, the method What do you think would be a good approach to this? I'm working on it right now. PS. if you could tell me how can I run the package from the source code, not the pip version, so I can evaluate the changes I'm making, I'd be thankful. |
I think you're on the right track. The method is the evaluator, however, when running Check development for setting it up locally. Happy to help further if needed. |
I was thinking about an approach to verify whether a method has a docstring or not. One idea that comes to mind that utilizes the MethodInterface class is using regex. We could look for a |
Hi @Zarad1993, this would be my first contributing to any project so please let me know if I am wrong somewhere, I looked through the code and found out that when we remove the comments and only blank quotes are present Please let me know if it is a correct approach or diff_only should remain true. |
Hi @nilesh-kaizen - I'm not sure of the potential side effects for this, yet. Feel free to open a PR and add some tests for it to proof case your fix. Thanks |
Hello, is anyone still working on this? |
Hi @Marinette - You are welcome to look at it. I think it's been a while and there isn't a PR out yet. |
Removing docstrings from a method should still make
dyc diff
work. If we remove that at the moment it will treat the code like it's documented.The text was updated successfully, but these errors were encountered: