Skip to content

Add doctest example and improve docstring in simulated_annealing#14399

Closed
galleazzijuniorsoftwareenginer wants to merge 2 commits intoTheAlgorithms:masterfrom
galleazzijuniorsoftwareenginer:add_validation_haversine_distance
Closed

Add doctest example and improve docstring in simulated_annealing#14399
galleazzijuniorsoftwareenginer wants to merge 2 commits intoTheAlgorithms:masterfrom
galleazzijuniorsoftwareenginer:add_validation_haversine_distance

Conversation

@galleazzijuniorsoftwareenginer
Copy link
Contributor

Description

This PR improves the documentation of the simulated_annealing implementation.

Changes:

  • Added a simple doctest example to the docstring
  • Improved the Returns section formatting

These changes improve readability and help increase test coverage through doctests.

@algorithms-keeper
Copy link

Closing this pull request as invalid

@galleazzijuniorsoftwareenginer, 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 invalid awaiting reviews This PR is ready to be reviewed labels Mar 14, 2026
@algorithms-keeper algorithms-keeper bot removed the awaiting reviews This PR is ready to be reviewed label Mar 14, 2026
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