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

Using ruff rule to enforce the existence of docstrings in public functions #1062

Merged
merged 6 commits into from
Sep 10, 2024

Conversation

h-mayorquin
Copy link
Collaborator

As in the title.

@h-mayorquin h-mayorquin self-assigned this Sep 7, 2024
@h-mayorquin h-mayorquin changed the title Using ruff rule to enforce the existence of docsrings on public functions Using ruff rule to enforce the existence of docsrings in public functions Sep 7, 2024
@h-mayorquin h-mayorquin changed the title Using ruff rule to enforce the existence of docsrings in public functions Using ruff rule to enforce the existence of docstrings in public functions Sep 9, 2024
Copy link
Member

@pauladkisson pauladkisson left a comment

Choose a reason for hiding this comment

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

lgtm!

@h-mayorquin h-mayorquin enabled auto-merge (squash) September 9, 2024 23:37
@h-mayorquin h-mayorquin merged commit ab37a4e into main Sep 10, 2024
34 of 35 checks passed
@h-mayorquin h-mayorquin deleted the more_ruff_rule branch September 10, 2024 04:49
Copy link

codecov bot commented Dec 9, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 90.31%. Comparing base (81a022d) to head (b82a08c).
Report is 60 commits behind head on main.

Additional details and impacted files

Impacted file tree graph

@@            Coverage Diff             @@
##             main    #1062      +/-   ##
==========================================
- Coverage   90.32%   90.31%   -0.01%     
==========================================
  Files         129      129              
  Lines        7996     7989       -7     
==========================================
- Hits         7222     7215       -7     
  Misses        774      774              
Flag Coverage Δ
unittests 90.31% <100.00%> (-0.01%) ⬇️

Flags with carried forward coverage won't be shown. Click here to find out more.

Files with missing lines Coverage Δ
...rfaces/ecephys/blackrock/blackrockdatainterface.py 94.54% <100.00%> (ø)
...v/datainterfaces/ecephys/blackrock/header_tools.py 100.00% <100.00%> (ø)
src/neuroconv/tools/roiextractors/roiextractors.py 82.22% <100.00%> (+0.03%) ⬆️
...c/neuroconv/tools/spikeinterface/spikeinterface.py 90.77% <100.00%> (-0.93%) ⬇️
src/neuroconv/tools/testing/mock_probes.py 0.00% <ø> (ø)
src/neuroconv/utils/json_schema.py 96.87% <100.00%> (ø)

... and 1 file with indirect coverage changes

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.

2 participants