Python icon indicating copy to clipboard operation
Python copied to clipboard

Add-README-files-3/8

Open Leoriem-code opened this issue 4 years ago • 4 comments

Describe your change:

The 3rd of the serie

  • [ ] Add an algorithm?
  • [ ] Fix a bug or typo in an existing algorithm?
  • [x] Documentation change?

Checklist:

  • [x] I have read CONTRIBUTING.md.
  • [x] This pull request is all my own work -- I have not plagiarized.
  • [x] I know that pull requests will not be merged if they fail the automated tests.
  • [x] This PR only changes one algorithm file. To ease review, please open separate PRs for separate algorithms.
  • [x] All new Python files are placed inside an existing directory.
  • [x] All filenames are in all lowercase characters with no spaces or dashes.
  • [x] All functions and variable names follow Python naming conventions.
  • [x] All function parameters and return values are annotated with Python type hints.
  • [x] All functions have doctests that pass the automated testing.
  • [x] All new algorithms have a URL in its comments that points to Wikipedia or other similar explanation.
  • [x] If this pull request resolves one or more open issues then the commit message contains Fixes: #{$ISSUE_NO}.

Leoriem-code avatar Nov 11 '21 15:11 Leoriem-code

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.

Leoriem-code avatar Mar 09 '22 15:03 Leoriem-code

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[bot] avatar Apr 16 '22 03:04 stale[bot]

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[bot] avatar Jun 13 '22 04:06 stale[bot]

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[bot] avatar Jul 31 '22 04:07 stale[bot]

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.

tianyizheng02 avatar Aug 22 '23 23:08 tianyizheng02