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

Add docstrings and fix closing of LogServer #40

Merged
merged 2 commits into from
Oct 7, 2024

Conversation

lamr02n
Copy link
Collaborator

@lamr02n lamr02n commented Oct 6, 2024

I added missing docstrings to the LogServer and Prefilter code. Additionally, instead of implementing a close method for the LogServer, I adjusted the open() method to securely stop the instance. Resolves #24

@lamr02n lamr02n self-assigned this Oct 6, 2024
Copy link

github-actions bot commented Oct 6, 2024

☂️ Python Coverage

current status: ✅

Overall Coverage

Lines Covered Coverage Threshold Status
1188 1082 91% 0% 🟢

New Files

No new covered files...

Modified Files

File Coverage Status
src/logserver/server.py 100% 🟢
src/prefilter/prefilter.py 100% 🟢
TOTAL 100% 🟢

updated for commit: 4893eec by action🐍

@codecov-commenter
Copy link

codecov-commenter commented Oct 6, 2024

⚠️ Please install the 'codecov app svg image' to ensure uploads and comments are reliably processed by Codecov.

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 90.48%. Comparing base (4e2ec31) to head (4893eec).

❗ Your organization needs to install the Codecov GitHub app to enable full functionality.

Additional details and impacted files
@@           Coverage Diff           @@
##             main      #40   +/-   ##
=======================================
  Coverage   90.48%   90.48%           
=======================================
  Files          11       11           
  Lines        1188     1188           
  Branches      148      148           
=======================================
  Hits         1075     1075           
  Misses        106      106           
  Partials        7        7           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@lamr02n lamr02n added documentation Improvements or additions to documentation bug Something isn't working labels Oct 6, 2024
Copy link
Owner

@stefanDeveloper stefanDeveloper left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

documentation is always welcome! :)

@stefanDeveloper stefanDeveloper merged commit b285b1f into main Oct 7, 2024
15 checks passed
@stefanDeveloper stefanDeveloper deleted the update-documentation branch October 7, 2024 13:24
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

LogServer does not have a proper close method
3 participants