Skip to content

Comments

Revise README for improved structure and content#13706

Closed
Sohaibkamran-25 wants to merge 1 commit intoTheAlgorithms:masterfrom
Sohaibkamran-25:Python-Algorithms-Code
Closed

Revise README for improved structure and content#13706
Sohaibkamran-25 wants to merge 1 commit intoTheAlgorithms:masterfrom
Sohaibkamran-25:Python-Algorithms-Code

Conversation

@Sohaibkamran-25
Copy link

@Sohaibkamran-25 Sohaibkamran-25 commented Oct 23, 2025

Updated README to enhance clarity and add new sections.

Describe your change:

I have updated the readme.md file and improved its structure and made its readability better.

  • 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".

Updated README to enhance clarity and add new sections.
@algorithms-keeper
Copy link

Closing this pull request as invalid

@Sohaibkamran-25, 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 the awaiting reviews This PR is ready to be reviewed label Oct 23, 2025
@Sohaibkamran-25
Copy link
Author

I have marked now. Kindly check my PR again.

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

Labels

awaiting reviews This PR is ready to be reviewed invalid

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant