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

DOC: New documentation of PySherlock #480

Open
wants to merge 21 commits into
base: main
Choose a base branch
from
Open

Conversation

ansnfernand
Copy link
Collaborator

Description

New documentation of PySherlock with examples.

Checklist:

  • Run unit tests and make sure they all pass
    - Run tests without Sherlock running
    - Run tests with Sherlock GRPC connection
  • Check and fix style errors
    - pre-commit command line check
    - Problems tab in PyCharm
  • [] Bench test new/modified APIs by using and modifying the code in the example for the API method
  • Add new classes to rst files, located at: \doc\source\api
  • Generate documentation
  • Verify the HTML. It gets generated at: \doc\build\html.
    - Open index.html
    - Click on "API Reference" at the top.
    - Verify HTML for API changes.
  • Check that test code coverage is at least 80% when Sherlock is running
  • Make sure that the title of the pull request follows Commit naming conventions (e.g. feat: adding new PySherlock command)

@ansnfernand ansnfernand added the documentation Improvements or additions to documentation label Dec 30, 2024
@ansnfernand ansnfernand added this to the v0.8.0 milestone Dec 30, 2024
@ansnfernand ansnfernand self-assigned this Dec 30, 2024
@github-actions github-actions bot added dependencies Related with project dependencies maintenance Package and maintenance related labels Dec 30, 2024
Copy link

codecov bot commented Jan 2, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 60.25%. Comparing base (2a61d77) to head (472e271).
Report is 1 commits behind head on main.

Additional details and impacted files
@@            Coverage Diff             @@
##             main     #480      +/-   ##
==========================================
+ Coverage   60.22%   60.25%   +0.02%     
==========================================
  Files          23       23              
  Lines        4983     5032      +49     
==========================================
+ Hits         3001     3032      +31     
- Misses       1982     2000      +18     

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

@ansnfernand ansnfernand changed the title FEAT: New documentation of PySherlock DOC: New documentation of PySherlock Jan 2, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
dependencies Related with project dependencies documentation Improvements or additions to documentation maintenance Package and maintenance related
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Add examples to the documentation Add examples to the documentation
2 participants