Skip to content

markdown consistency #4461

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.

Sign up for GitHub

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

Jump to bottom
Merged
merged 3 commits into from
May 31, 2021
Merged

markdown consistency #4461

merged 3 commits into from
May 31, 2021

Conversation

vivian-dai
Copy link
Contributor

@vivian-dai vivian-dai commented May 28, 2021 •
edited
Loading

Describe your change:

  • markdown used both ** and __ for bold as well as * and _ for italics, changed all to use *

  • used ` for methods and other code related things rather than bolding

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

not an algorithms therefore most of the items on this checklist is irrelevant to this pr so I'm just going to check everything off

@ghost ghost added documentation This PR modified documentation files awaiting reviews This PR is ready to be reviewed labels May 28, 2021
Prajwalprakash3722
Prajwalprakash3722 approved these changes May 28, 2021
View reviewed changes
Copy link

@Prajwalprakash3722 Prajwalprakash3722 left a comment

Choose a reason for hiding this comment

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

Everything looks good to me 👍🏼

cclauss
cclauss approved these changes May 31, 2021
View reviewed changes
Copy link
Member

@cclauss cclauss left a comment

Choose a reason for hiding this comment

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

I find __ easier to scan over when editing than ** but this looks GREAT. Thanks!

@ghost ghost removed the awaiting reviews This PR is ready to be reviewed label May 31, 2021
@cclauss cclauss merged commit 04f156a into TheAlgorithms:master May 31, 2021
Kommandat pushed a commit to Kommandat/Python that referenced this pull request May 31, 2021
@vivian-dai @cclauss @Kommandat
markdown consistency (TheAlgorithms#4461)
d09b671 
* markdown consistency

* Swap ** for __

Co-authored-by: Christian Clauss <[email protected]>
shermanhui pushed a commit to shermanhui/Python that referenced this pull request Oct 22, 2021
@vivian-dai @cclauss @shermanhui
markdown consistency (TheAlgorithms#4461)
da89202 
* markdown consistency

* Swap ** for __

Co-authored-by: Christian Clauss <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@cclauss cclauss cclauss approved these changes

@Prajwalprakash3722 Prajwalprakash3722 Prajwalprakash3722 approved these changes

Assignees
No one assigned
Labels
documentation This PR modified documentation files
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@vivian-dai @cclauss @Prajwalprakash3722