Skip to content

Add-README-files-3/8#5819

Closed
Leoriem-code wants to merge 8 commits into
TheAlgorithms:masterfrom
Leoriem-code:add-README-files-3/8
Closed

Add-README-files-3/8#5819
Leoriem-code wants to merge 8 commits into
TheAlgorithms:masterfrom
Leoriem-code:add-README-files-3/8

Conversation

@Leoriem-code
Copy link
Copy Markdown
Contributor

@Leoriem-code Leoriem-code commented Nov 11, 2021

Describe your change:

The 3rd of the serie

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

@ghost ghost added awaiting reviews This PR is ready to be reviewed documentation This PR modified documentation files labels Nov 11, 2021
@ghost ghost added the tests are failing Do not merge until tests pass label Mar 9, 2022
@Leoriem-code
Copy link
Copy Markdown
Contributor Author

Leoriem-code commented Mar 9, 2022

Okay, I yield.
When testing with doctest, there is no problems, same when using pytest --doctest-modules --ignore=project_euler/ --ignore=scripts/validate_solutions.py --cov-report=term-missing:skip-covered --cov=. arithmetic_analysis/in_static_equilibrium.py.
I have no idea what cause the error, and it's noot even my fault to begin with.

@stale
Copy link
Copy Markdown

stale Bot commented Apr 16, 2022

This pull request has been automatically marked as stale because it has not had recent activity. It will be closed if no further activity occurs. Thank you for your contributions.

@stale stale Bot added the stale Used to mark an issue or pull request stale. label Apr 16, 2022
@stale stale Bot removed the stale Used to mark an issue or pull request stale. label Apr 16, 2022
@ghost ghost removed the tests are failing Do not merge until tests pass label Apr 16, 2022
@stale
Copy link
Copy Markdown

stale Bot commented Jun 13, 2022

This pull request has been automatically marked as stale because it has not had recent activity. It will be closed if no further activity occurs. Thank you for your contributions.

@stale stale Bot added the stale Used to mark an issue or pull request stale. label Jun 13, 2022
@stale stale Bot removed the stale Used to mark an issue or pull request stale. label Jun 21, 2022
@stale
Copy link
Copy Markdown

stale Bot commented Jul 31, 2022

This pull request has been automatically marked as stale because it has not had recent activity. It will be closed if no further activity occurs. Thank you for your contributions.

@stale stale Bot added the stale Used to mark an issue or pull request stale. label Jul 31, 2022
CaedenPH
CaedenPH requested changes Aug 14, 2023
View reviewed changes
Copy link
Copy Markdown
Contributor

@CaedenPH CaedenPH left a comment •
edited
Loading

Choose a reason for hiding this comment

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

I like the idea of adding README's to each directory, however the content here is insufficient an phrased incorrectly

@tianyizheng02 What is your opinion?

Comment thread arithmetic_analysis/in_static_equilibrium.py
Comment on lines -22 to -23
>>> polar_force(10, 3.14, radian_mode=True)
[-9.999987317275396, 0.01592652916486828]
Copy link
Copy Markdown
Contributor

@CaedenPH CaedenPH Aug 14, 2023

Choose a reason for hiding this comment

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

Can this change be reverted? Not sure why it was made

Comment thread data_structures/README.md
@@ -0,0 +1,9 @@
# Data Structures

There exist [many](https://en.wikipedia.org/wiki/List_of_data_structures) types of data structures, but some structures are more useful to keep some type of data over another type.
Copy link
Copy Markdown
Contributor

@CaedenPH CaedenPH Aug 14, 2023

Choose a reason for hiding this comment

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

Suggested change
There exist [many](https://en.wikipedia.org/wiki/List_of_data_structures) types of data structures, but some structures are more useful to keep some type of data over another type.
[Many](https://en.wikipedia.org/wiki/List_of_data_structures) types of data structures exist, but some structures are more useful than others when storing certain types of data.

Comment thread data_structures/README.md
(If this subject has your interest, you should do your own research because it is a vast subject. As often, the starting point should be the Wikipedia page.)

* <https://en.wikipedia.org/wiki/Data_structure>
* <https://www.tommyds.it/doc/benchmark.html>
Copy link
Copy Markdown
Contributor

@CaedenPH CaedenPH Aug 14, 2023

Choose a reason for hiding this comment

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

Doesn't seem relevant

Comment thread digital_image_processing/README.md
@@ -0,0 +1,7 @@
# Digital Image Processing

Digital Image Processing (DIP) is when you are processing and applying changes to an image with a computer.
Copy link
Copy Markdown
Contributor

@CaedenPH CaedenPH Aug 14, 2023

Choose a reason for hiding this comment

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

Suggested change
Digital Image Processing (DIP) is when you are processing and applying changes to an image with a computer.
Digital Image Processing (DIP) is the process of applying changes to an image digitally

Comment thread data_structures/README.md
# Data Structures

There exist [many](https://en.wikipedia.org/wiki/List_of_data_structures) types of data structures, but some structures are more useful to keep some type of data over another type.
The types used everywhere when programming is the boolean, the integer, the character and the floating point number. Those can lead to more advanced type, such as list, array, set, tuple, stack etc.
Copy link
Copy Markdown
Contributor

@CaedenPH CaedenPH Aug 14, 2023

Choose a reason for hiding this comment

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

This line is wordy and doesn't make sense

@tianyizheng02
Copy link
Copy Markdown
Contributor

tianyizheng02 commented Aug 22, 2023

I like the idea of adding README's to each directory, however the content here is insufficient an phrased incorrectly

@tianyizheng02 What is your opinion?

@CaedenPH I agree, the content needs to be significantly expanded upon and the grammar/wording is a bit questionable. Having directory READMEs is definitely good documentation so we'll just have to wait until someone else opens another PR contributing one.

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

Reviewers

@CaedenPH CaedenPH CaedenPH requested changes

@Kush1101 Kush1101 Awaiting requested review from Kush1101

Assignees

No one assigned

Labels

awaiting reviews This PR is ready to be reviewed documentation This PR modified documentation files stale Used to mark an issue or pull request stale.

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

3 participants

@Leoriem-code @tianyizheng02 @CaedenPH