Fixes wiki and doctest issues #11227

MarlieChiller · 2024-01-02T10:44:02Z

Describe your change:

Fixes a markdown typo in the wiki (unable to edit the wiki directly in a PR so I think @Siddharth1605 added the files as new to be ported). In doing so, the ci doctests pipeline failed for calculate_age in web_programming/get_top_billionaires.py which I refactored and addressed

[closes #11225]

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:

MarlieChiller · 2024-01-02T10:52:40Z

I havent taken the time to fully understand the code in the calculate_age function but the doctests seem a bit brittle here. It doesnt seem coincidence that these fail just after a new year starts. A little strange that its a smaller number rather than a larger number as well but that could be down to my limited undestanding

MarlieChiller · 2024-01-02T14:02:15Z

Python.wiki/Home.md

@@ -0,0 +1,6 @@
+## Python Algorithms


Yes, I suppose that is true. In fixing the wiki issue, the doctests issue was highlighted. Both are addressed here

cclauss · 2024-01-02T15:27:44Z

Python.wiki/Sorting-Algorithms.md

+<br/>
+
+<ol>
+<li><a href="">Selection Sort</a></li>


I am a bit uncomfortable with an unsorted list of sorting algorithms. Are these sorted alphabetically, sorted for speed, or other? DIRECTORY.md is machine-generated to keep algorithms up-to-date and sorted alphabetically.

This is a like for like drop-in except for the corrected markdown. The existing pages algorithms were already sorted like this. Ultimately, I was just trying to fix the issue highlighted in #11227 which also has the unsorted list. The wiki can be edited in the GUI by a repo admin in <30seconds

cclauss · 2024-01-02T15:28:27Z

Python.wiki/Sorting-Algorithms.md

+<li><a href="">Binary Insertion Sort</a></li>
+<li><a href="">BogoSort or Permutation Sort</a></li>
+<li><a href="">Gnome Sort</a></li>
+<li><a href="">Sleep Sort – The King of Laziness / Sorting while Sleeping</a></li>


I HATE this algorithm because it wastes time and compute power.

web_programming/get_top_billionaires.py

Fixed calculate_age function such that is returns the age correctly from a given timestamp. Fixed doctests to be robust when year changes

for more information, see https://pre-commit.ci

removed unused import

MarlieChiller · 2024-01-03T11:53:58Z

@cclauss Ive updated the whole calculate_age function and related doctests as I dont think it was achieving what it set out to do initially. Please review changes when appropriate. I can see new PRs against this repo are now failing due to this function and its doctests in master branch

cclauss · 2024-01-15T09:58:51Z

The get_top_billionaires() issue was fixed in #11234 so please revert all changes to that file.

cclauss · 2024-01-15T14:23:28Z

I am lost trying to figure out how this works. If I go to https://github.com/TheAlgorithms/Python/wiki I already get most of this. Could you let me know why what we have already is not enough?

When I click on List of Algorithms and scroll down to Sorts I get https://github.com/TheAlgorithms/Python/blob/master/DIRECTORY.md#sorts which is an alphabetized list of all sort algorithms that is kept up to date by https://github.com/TheAlgorithms/Python/blob/master/.github/workflows/directory_writer.yml every time a pull request is created. Why do we want a manual, unsorted list of sorts? How is that a better user experience?

It is more customary and easier to find if the information about best case, worst case, is documented in
https://github.com/TheAlgorithms/Python/blob/master/sorts/README.md

MarlieChiller · 2024-01-15T18:24:05Z

This PR is literally only to fix the typos that I found in the markdown of the wiki as mentioned in 11225. You only need to correct those typos now as you have fixed the other changes that I spent time correcting in get_top_billionaires.py.

MarlieChiller · 2024-01-15T18:28:28Z

To put it most simply, please visit https://github.com/TheAlgorithms/Python/wiki/Sorting-Algorithms#selection-sort. It is misformatted and links to the wrong algorithm (bubble sort rather than selection sort). You can lift the relevant markdown from this PR directly into the wiki to resolve this issue. Github has no way of easily opening PRs against wiki pages

Siddharth1605 and others added 2 commits January 2, 2024 09:10

wiki has been updated

76dec73

Update get_top_billionaires.py to fix doctest failure

cc28eed

MarlieChiller requested a review from cclauss as a code owner January 2, 2024 10:44

algorithms-keeper bot added the tests are failing Do not merge until tests pass label Jan 2, 2024

Update get_top_billionaires.py

7d55e21

algorithms-keeper bot added awaiting reviews This PR is ready to be reviewed and removed tests are failing Do not merge until tests pass labels Jan 2, 2024

Update get_top_billionaires.py

553eb82

algorithms-keeper bot added the tests are failing Do not merge until tests pass label Jan 2, 2024

Update get_top_billionaires.py

c786649

algorithms-keeper bot removed the tests are failing Do not merge until tests pass label Jan 2, 2024

MarlieChiller changed the title ~~Fixes wiki and doctest issues in python repo~~ Fixes wiki and doctest issues Jan 2, 2024

MarlieChiller commented Jan 2, 2024

View reviewed changes

cclauss requested changes Jan 2, 2024

View reviewed changes

MarlieChiller and others added 3 commits January 3, 2024 11:50

Update get_top_billionaires.py

aae2164

Fixed calculate_age function such that is returns the age correctly from a given timestamp. Fixed doctests to be robust when year changes

[pre-commit.ci] auto fixes from pre-commit.com hooks

9c0424c

for more information, see https://pre-commit.ci

removed unused import

aa5885e

removed unused import

MarlieChiller requested a review from cclauss January 3, 2024 11:55

MarlieChiller added 2 commits January 3, 2024 13:48

removed redundant comment

655419a

Merge branch 'master' into patch-1

24b3d42

algorithms-keeper bot added the tests are failing Do not merge until tests pass label Jan 15, 2024

Update get_top_billionaires.py

d8b299d

algorithms-keeper bot removed the tests are failing Do not merge until tests pass label Jan 15, 2024

Update get_top_billionaires.py

72c1ae3

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Fixes wiki and doctest issues #11227

Fixes wiki and doctest issues #11227

MarlieChiller commented Jan 2, 2024 •

edited

MarlieChiller commented Jan 2, 2024 •

edited

MarlieChiller Jan 2, 2024

cclauss Jan 2, 2024 •

edited

MarlieChiller Jan 2, 2024 •

edited

cclauss Jan 2, 2024

MarlieChiller commented Jan 3, 2024 •

edited

cclauss commented Jan 15, 2024 •

edited

cclauss commented Jan 15, 2024 •

edited

MarlieChiller commented Jan 15, 2024

MarlieChiller commented Jan 15, 2024 •

edited

Fixes wiki and doctest issues #11227

Are you sure you want to change the base?

Fixes wiki and doctest issues #11227

Conversation

MarlieChiller commented Jan 2, 2024 • edited

Describe your change:

Checklist:

MarlieChiller commented Jan 2, 2024 • edited

MarlieChiller Jan 2, 2024

Choose a reason for hiding this comment

cclauss Jan 2, 2024 • edited

Choose a reason for hiding this comment

MarlieChiller Jan 2, 2024 • edited

Choose a reason for hiding this comment

cclauss Jan 2, 2024

Choose a reason for hiding this comment

MarlieChiller commented Jan 3, 2024 • edited

cclauss commented Jan 15, 2024 • edited

cclauss commented Jan 15, 2024 • edited

MarlieChiller commented Jan 15, 2024

MarlieChiller commented Jan 15, 2024 • edited

MarlieChiller commented Jan 2, 2024 •

edited

MarlieChiller commented Jan 2, 2024 •

edited

cclauss Jan 2, 2024 •

edited

MarlieChiller Jan 2, 2024 •

edited

MarlieChiller commented Jan 3, 2024 •

edited

cclauss commented Jan 15, 2024 •

edited

cclauss commented Jan 15, 2024 •

edited

MarlieChiller commented Jan 15, 2024 •

edited