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 work + type hints + refactor – artifacts.py -- dangles #125

Merged
merged 4 commits into from
Dec 2, 2024

Conversation

jGaboardi
Copy link
Collaborator

This PR:

  • adds docstring + type hints to artifacts.remove_dangles()
  • adds docstring + type hints to artifacts.is_dangles()
  • does small internal refactor within artifacts.is_dangles()
  • xref testing, refactor, & docstrings #20

@jGaboardi jGaboardi added documentation Improvements or additions to documentation refactor & code maint labels Dec 2, 2024
@jGaboardi jGaboardi requested a review from martinfleis December 2, 2024 20:00
@jGaboardi jGaboardi self-assigned this Dec 2, 2024
@jGaboardi jGaboardi mentioned this pull request Dec 2, 2024
5 tasks
sgeop/artifacts.py Outdated Show resolved Hide resolved
sgeop/artifacts.py Outdated Show resolved Hide resolved
Copy link

codecov bot commented Dec 2, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 98.8%. Comparing base (42701b2) to head (947221a).
Report is 1 commits behind head on main.

Additional details and impacted files

Impacted file tree graph

@@          Coverage Diff          @@
##            main    #125   +/-   ##
=====================================
  Coverage   98.8%   98.8%           
=====================================
  Files          6       6           
  Lines        960     962    +2     
=====================================
+ Hits         948     950    +2     
  Misses        12      12           
Files with missing lines Coverage Δ
sgeop/artifacts.py 97.9% <100.0%> (+<0.1%) ⬆️

@jGaboardi jGaboardi changed the title doc work + type hints + refactor – artifacts.py doc work + type hints + refactor – artifacts.py -- dangles Dec 2, 2024
@jGaboardi jGaboardi merged commit 0d847da into main Dec 2, 2024
11 checks passed
@jGaboardi jGaboardi deleted the GH20_artifacts_docstrings_remove_dangles branch December 2, 2024 22:25
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation refactor & code maint
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants