-
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
Implement Class Docstrings as per Issue #5 #67 #68
Conversation
Thank you @calkerns for submitting a pull request! |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Could you check the README
to be documenting the latest changes you are adding?
Thank you so much, again!
Hi @Zarad1993, you're welcome; thank you for your response! Yes, you are so right; documentation is needed! My colleague and I will get to work on that tomorrow. |
Hi @Zarad1993 , we updated the README with the documentation for the ClassBuilder options as well as clarified the --test flag (renamed it to --skip-confirm) because all it does is bypass the popup editor in the confirmation phase. This has also been added under the Usage section of the README as it is also useful for the end-user, not just for testing purposes. Let us know if we should make any other changes! |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Why do we need the automated_class_tests
directory? 🤔
I might be missing something.
Like tests/automated_class_tests/user_input/class_test_1.in
. Not sure what that does or it needs to be in the PR
Hey guys 👋 , just want to let you know tests are failing. |
Hi @Zarad1993 , my bad about tests failing, I am trying a few things with regards to pytest and am aware of this issue, sorry about that. In regards to the |
I love it, man! Let me know when it's ready for review. Keep it up, guys! If you guys have LinkedIn profiles, I'm happy to connect https://linkedin.com/in/zarad1993 . I'd like to give you guys a shoutout |
Sounds good, also happy to connect on LinkedIn! Also part of the reason we created the |
Hey @Zarad1993 , we repurposed the We hope this will suffice! |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Nice work, thanks folks!
@Zarad1993 I would be happy to connect on LinkedIn as well! Thank you for offering and for working with us on this PR! |
Reference Issue: #5 Classes Docstrings
This was a Joint effort between @AshirGuptash and I.
Key Changes
Add classes.py file
Add preliminary script-based unit test suite for classes
Add --test flag in DYC for automated testing purposes
Apply Black formatter on all files to ensure consistency
The main body of this is in regards to creating a ClassBuilder object to handle adding docstrings to the start of classes. Currently, it only supports adding details on inheritance to the docstring, but can be further be modified to handle other variables such as __init__ parameters or class attributes.