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 simplify.simplify_{singletons, pairs}(), etc. #116

Merged
merged 7 commits into from
Dec 2, 2024

Conversation

jGaboardi
Copy link
Collaborator

@jGaboardi jGaboardi commented Nov 28, 2024

This PR:

@jGaboardi jGaboardi added documentation Improvements or additions to documentation refactor & code maint labels Nov 28, 2024
@jGaboardi jGaboardi self-assigned this Nov 28, 2024
@jGaboardi jGaboardi mentioned this pull request Nov 28, 2024
5 tasks
Copy link

codecov bot commented Nov 28, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 99.0%. Comparing base (cfe7273) to head (7b804ae).
Report is 4 commits behind head on main.

Additional details and impacted files

Impacted file tree graph

@@          Coverage Diff          @@
##            main    #116   +/-   ##
=====================================
  Coverage   98.9%   99.0%           
=====================================
  Files          6       6           
  Lines        936     954   +18     
=====================================
+ Hits         926     944   +18     
  Misses        10      10           
Files with missing lines Coverage Δ
sgeop/simplify.py 99.0% <100.0%> (+0.1%) ⬆️

Copy link
Contributor

@martinfleis martinfleis left a comment

Choose a reason for hiding this comment

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

I think that you may be overdoing it occasionally...

sgeop/simplify.py Outdated Show resolved Hide resolved
Comment on lines +339 to +340
_id_np = lambda x: sum(artifacts.loc[artifacts["comp"] == x.comp]["non_planar"]) # noqa: E731
artifacts["non_planar_cluster"] = artifacts.apply(_id_np, axis=1)
Copy link
Contributor

Choose a reason for hiding this comment

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

Sometimes I wonder if refactors of this sort are worth it. I don't consider the original less readable (maybe more), and it does not require linting exception.

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

While I think this is more readable, I completely understand your view. I have no problem reverting.

sgeop/simplify.py Outdated Show resolved Hide resolved
Comment on lines +396 to +397
_1st = pd.DataFrame()
_2nd = pd.DataFrame()
Copy link
Contributor

Choose a reason for hiding this comment

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

why??

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

More readable for me, but I have no problem reverting.

@jGaboardi
Copy link
Collaborator Author

I think that you may be overdoing it occasionally...

Agreed. Was thinking that when I was pushing this up.

@jGaboardi
Copy link
Collaborator Author

So how do we feel if I revert most of the non-function refactors? I probably went too far down the rabbit hole of this.

@martinfleis
Copy link
Contributor

Leave it as it is but avoid doing that next time :)

@jGaboardi
Copy link
Collaborator Author

Fair enough.

@jGaboardi
Copy link
Collaborator Author

@martinfleis Is this OK to merge?

@martinfleis
Copy link
Contributor

Yeah

@jGaboardi jGaboardi merged commit 089267d into main Dec 2, 2024
11 checks passed
@jGaboardi jGaboardi deleted the GH20_simplify_docstrings branch December 2, 2024 16:55
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