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

style(tracingfuncs): Numpydoc validation, PEP8 & tidying #947

Closed
wants to merge 741 commits into from

Conversation

ns-rse
Copy link
Collaborator

@ns-rse ns-rse commented Oct 14, 2024

This commit is squash of seven individual commits that address Numpydoc validation

  • style(tracingfuncs): GL01/GL02 Numpydoc validation
  • style(tracingfuncs): SS06 Numpydoc validation
  • style(tracingfuncs): GL08 Numpydoc validation
  • style(tracingfuncs): PR01/RT01 Numpydoc validation

Removes unused functions/methods...

  • fix(tracingfuncs): Removes circularTrace_old
  • fix(tracingfuncs): Remove unused getLocalPixelsBinary

Renames methods to adhere to PEP8

  • style(tracingfuncs): PEP8 renaming camel-case method to snake-case

Questions

check_vectors_candidate_points - part 1

This function (nee checkVectorsCandidatePoints) takes the parameters x and y but these are never used directly,
rather x and y are obtained anew in each iteration of this loop...

        for x_n, y_n in candidate_points:
            x = x_n - x_ref_2
            y = y_n - y_ref_2

            theta = math.atan2(x, y)

            x_y_theta.append([x_n, y_n, abs(theta - ref_theta)])

We should be able to just drop x and y as parameters to this method but I wanted to check as there aren't any tests
for these methods/functions.

check_vectors_candidate_points - part 2

I also noticed that in some places check_vectors_candidate_points (nee checkVectorsCandidatePoints)
was commented out (lines 83 and 187) in favour of using find_next_best_point (nee findNextBestPoint) but
check_vectors_candidate_points is still used in some places. Is this deliberate? Can or should find_next_best_point
replace all calls made to check_vectors_candidate_points

pre-commit-ci bot and others added 30 commits August 15, 2024 15:58
…/TopoStats into SylviaWhittle/800-splining-tests
SylviaWhittle and others added 28 commits October 10, 2024 15:47
…racing' into maxgamill-sheffield/800-better-tracing
This commit is squash of seven individual commits that address Numpydoc validation

- style(tracingfuncs): GL01/GL02 Numpydoc validation
- style(tracingfuncs): SS06 Numpydoc validation
- style(tracingfuncs): GL08 Numpydoc validation
- style(tracingfuncs): PR01/RT01 Numpydoc validation

Removes unused functions/methods...

- fix(tracingfuncs): Removes circularTrace_old
- fix(tracingfuncs): Remove unused getLocalPixelsBinary

Renames methods to adhere to PEP8

- style(tracingfuncs): PEP8 renaming camel-case method to snake-case
@ns-rse
Copy link
Collaborator Author

ns-rse commented Oct 14, 2024

Wrong target branch, ignore.

@ns-rse ns-rse closed this Oct 14, 2024
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.

4 participants