Add anti patterns sectiAdd “Anti-Patterns” section to README with explanations (#256)on#459
Merged
faif merged 3 commits intofaif:masterfrom Nov 25, 2025
Merged
Conversation
Contributor
Author
|
Hi 👋, This PR adds an “Anti-Patterns” section to the README to clarify which design patterns are discouraged in Python and why. I also fixed the typo “Singelton” → “Singleton” and cleaned up some docstring formatting. Hope this helps make the documentation more beginner-friendly and Pythonic! Thanks for reviewing 🙏 |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary:-
This PR adds a new “Anti-Patterns” section to the README file to explain which common design patterns are discouraged in Python and why.
Changes Made:-
Added a new section titled Anti-Patterns in README.md.
Explained why patterns like Singleton, God Object, and Overuse of Inheritance are not Pythonic.
Fixed earlier typo from “Singelton” → “Singleton”.
Followed Markdown structure and formatting style of the existing README.
mpact:-
Helps developers understand which patterns to avoid in Python projects.
Makes README more informative and beginner-friendly.
Addresses feedback from issue #256 about missing anti-pattern clarification.