Skip to content

Conversation

@definus6-dev
Copy link

@definus6-dev definus6-dev commented Jan 23, 2026

Describe your change:

  • Add an algorithm?
  • Fix a bug or typo in an existing algorithm?
  • Add or change doctests? -- Note: Please avoid changing both code and tests in a single pull request.
  • Documentation change?

Checklist:

  • I have read CONTRIBUTING.md.
  • This pull request is all my own work -- I have not plagiarized.
  • I know that pull requests will not be merged if they fail the automated tests.
  • This PR only changes one algorithm file. To ease review, please open separate PRs for separate algorithms.
  • All new Python files are placed inside an existing directory.
  • All filenames are in all lowercase characters with no spaces or dashes.
  • All functions and variable names follow Python naming conventions.
  • All function parameters and return values are annotated with Python type hints.
  • All functions have doctests that pass the automated testing.
  • All new algorithms include at least one URL that points to Wikipedia or another similar explanation.
  • If this pull request resolves one or more open issues then the description above includes the issue number(s) with a closing keyword: "Fixes #ISSUE-NUMBER".

Additional Context

This PR improves the shear_stress.py module by aligning the implementation with fundamental physical principles and Pythonic best practices.

  • Refactored Interface: Replaced 0 as a placeholder with None.
  • Enhanced Documentation: Added core mechanical context for better understanding.
  • Robust Validation: Added non-negative checks and zero-division handling.

definus6-dev and others added 2 commits January 23, 2026 22:32
…ciples

- Refactored interface to use None for unknown variables (more idiomatic)
- Enhanced documentation with core mechanical context
- Added robust error handling for physical constraints and division by zero
@algorithms-keeper
Copy link

Closing this pull request as invalid

@definus6-dev, this pull request is being closed as none of the checkboxes have been marked. It is important that you go through the checklist and mark the ones relevant to this pull request. Please read the Contributing guidelines.

If you're facing any problem on how to mark a checkbox, please read the following instructions:

  • Read a point one at a time and think if it is relevant to the pull request or not.
  • If it is, then mark it by putting a x between the square bracket like so: [x]

NOTE: Only [x] is supported so if you have put any other letter or symbol between the brackets, that will be marked as invalid. If that is the case then please open a new pull request with the appropriate changes.

@algorithms-keeper algorithms-keeper bot added awaiting reviews This PR is ready to be reviewed invalid labels Jan 23, 2026
@algorithms-keeper algorithms-keeper bot removed the awaiting reviews This PR is ready to be reviewed label Jan 23, 2026
@definus6-dev
Copy link
Author

Hello! I apologize for missing the mandatory checklist in my initial submission. I have now updated the PR description with the completed checklist. Could you please review and reopen this PR? Thank you!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant