Skip to content
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

Subreddit.py improved readability #2166

Open
wants to merge 2 commits into
base: develop
Choose a base branch
from

Conversation

mvenus2
Copy link

@mvenus2 mvenus2 commented Oct 15, 2024

  • Extracted logic into smaller functions: get_reddit_instance, get_subreddit, get_submission, and collect_comments
  • Added comments to explain the purpose of functions and key steps
  • Organized code for better structure and readability

Description

The subreddit.py file was refactored to improve readability and maintainability by breaking down the code into smaller, focused functions. Comments were added to explain the purpose of functions and key steps, and the code was reorganized for better structure. These changes were made to make the code easier to understand and work with.

Issue Fixes

None

Checklist:

  • [ x ] I am pushing changes to the develop branch
  • [ x ] I am using the recommended development environment
  • [ x ] I have performed a self-review of my own code
  • [ x ] I have commented my code, particularly in hard-to-understand areas
  • [ x ] I have formatted and linted my code using python-black and pylint
  • [ x ] I have cleaned up unnecessary files
  • [ x ] My changes generate no new warnings
  • [ x ] My changes follow the existing code-style
  • [ x ] My changes are relevant to the project

Any other information (e.g how to test the changes)

None

- Extracted logic into smaller functions: get_reddit_instance, get_subreddit, get_submission, and collect_comments
- Added comments to explain the purpose of functions and key steps
- Organized code for better structure and readability
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant