Skip to content

Fix markdown for normal distribution quicksort #4875

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

Closed

Conversation

RolloCasanova
Copy link

  • MD001/heading-increment/header-increment: Heading levels should only increment by one level at a time
  • MD012/no-multiple-blanks: Multiple consecutive blank lines
  • MD026/no-trailing-punctuation: Trailing punctuation in heading
  • MD035/hr-style: Horizontal rule style
  • MD045/no-alt-text: Images should have alternate text (alt text)

Conventions from https://github.com/DavidAnson/markdownlint/blob/v0.24.0/doc/Rules.md

Describe your change:

  • Add an algorithm?
  • Fix a bug or typo in an existing algorithm?
  • 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 have a URL in its comments that points to Wikipedia or other similar explanation.
  • If this pull request resolves one or more open issues then the commit message contains Fixes: #{$ISSUE_NO}.

- MD001/heading-increment/header-increment: Heading levels should only increment by one level at a time
- MD012/no-multiple-blanks: Multiple consecutive blank lines
- MD026/no-trailing-punctuation: Trailing punctuation in heading
- MD035/hr-style: Horizontal rule style
- MD045/no-alt-text: Images should have alternate text (alt text)

Conventions from https://github.com/DavidAnson/markdownlint/blob/v0.24.0/doc/Rules.md
@ghost ghost added awaiting reviews This PR is ready to be reviewed documentation This PR modified documentation files labels Oct 1, 2021
Copy link
Contributor

@chakeson chakeson left a comment

Choose a reason for hiding this comment

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

Clearly an improvement. Here is the original one for full view and here is the new one.

@chakeson chakeson mentioned this pull request Oct 11, 2021
14 tasks
Comment on lines 3 to +4
Algorithm implementing QuickSort Algorithm where the pivot element is chosen randomly between first and last elements of the array and the array elements are taken from a Standard Normal Distribution.
This is different from the ordinary quicksort in the sense, that it applies more to real life problems , where elements usually follow a normal distribution. Also the pivot is randomized to make it a more generic one.

This is different from the ordinary quicksort in the sense, that it applies more to real life problems, where elements usually follow a normal distribution. Also the pivot is randomized to make it a more generic one.
Copy link
Member

Choose a reason for hiding this comment

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

Not so well written. Could you also improve it?

Algorithm implementing QuickSort Algorithm where the pivot element is chosen randomly between first and last elements of the array and the array elements are taken from a Standard Normal Distribution.
This is different from the ordinary quicksort in the sense, that it applies more to real life problems , where elements usually follow a normal distribution. Also the pivot is randomized to make it a more generic one.

This is different from the ordinary quicksort in the sense, that it applies more to real life problems, where elements usually follow a normal distribution. Also the pivot is randomized to make it a more generic one.

## Array Elements

The array elements are taken from a Standard Normal Distribution , having mean = 0 and standard deviation 1.
Copy link
Member

Choose a reason for hiding this comment

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

Suggested change
The array elements are taken from a Standard Normal Distribution , having mean = 0 and standard deviation 1.
The array elements are taken from a Standard Normal Distribution, having mean = 0 and standard deviation = 1.

Copy link
Member

Choose a reason for hiding this comment

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

Add a link to Standard Normal Distribution

---

---------------------
![normal distribution large](https://www.mathsisfun.com/data/images/normal-distrubution-large.gif)
Copy link
Member

Choose a reason for hiding this comment

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

@poyea poyea changed the title Fix some Markdown conventions Fix Markdown for normal distribution quicksort Oct 18, 2021
@poyea poyea changed the title Fix Markdown for normal distribution quicksort Fix markdown for normal distribution quicksort Oct 18, 2021
@poyea poyea self-assigned this Oct 18, 2021
Co-authored-by: John Law <johnlaw.po@gmail.com>
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 documentation This PR modified documentation files
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants