mirror of
https://github.com/TheAlgorithms/Python.git
synced 2025-01-18 16:27:02 +00:00
Update docs (#7867)
* Update docs, remove unused excludes from pre-commit * updating DIRECTORY.md Co-authored-by: github-actions <${GITHUB_ACTOR}@users.noreply.github.com>
This commit is contained in:
parent
17d93cab78
commit
57ccabbaeb
|
@ -7,10 +7,6 @@ repos:
|
||||||
- id: end-of-file-fixer
|
- id: end-of-file-fixer
|
||||||
types: [python]
|
types: [python]
|
||||||
- id: trailing-whitespace
|
- id: trailing-whitespace
|
||||||
exclude: |
|
|
||||||
(?x)^(
|
|
||||||
data_structures/heap/binomial_heap.py
|
|
||||||
)$
|
|
||||||
- id: requirements-txt-fixer
|
- id: requirements-txt-fixer
|
||||||
|
|
||||||
- repo: https://github.com/MarcoGorelli/auto-walrus
|
- repo: https://github.com/MarcoGorelli/auto-walrus
|
||||||
|
|
|
@ -66,7 +66,7 @@ pre-commit run --all-files --show-diff-on-failure
|
||||||
|
|
||||||
We want your work to be readable by others; therefore, we encourage you to note the following:
|
We want your work to be readable by others; therefore, we encourage you to note the following:
|
||||||
|
|
||||||
- Please write in Python 3.9+. For instance: `print()` is a function in Python 3 so `print "Hello"` will *not* work but `print("Hello")` will.
|
- Please write in Python 3.10+. For instance: `print()` is a function in Python 3 so `print "Hello"` will *not* work but `print("Hello")` will.
|
||||||
- Please focus hard on the naming of functions, classes, and variables. Help your reader by using __descriptive names__ that can help you to remove redundant comments.
|
- Please focus hard on the naming of functions, classes, and variables. Help your reader by using __descriptive names__ that can help you to remove redundant comments.
|
||||||
- Single letter variable names are *old school* so please avoid them unless their life only spans a few lines.
|
- Single letter variable names are *old school* so please avoid them unless their life only spans a few lines.
|
||||||
- Expand acronyms because `gcd()` is hard to understand but `greatest_common_divisor()` is not.
|
- Expand acronyms because `gcd()` is hard to understand but `greatest_common_divisor()` is not.
|
||||||
|
|
12
DIRECTORY.md
12
DIRECTORY.md
|
@ -158,6 +158,8 @@
|
||||||
* [Weight Conversion](conversions/weight_conversion.py)
|
* [Weight Conversion](conversions/weight_conversion.py)
|
||||||
|
|
||||||
## Data Structures
|
## Data Structures
|
||||||
|
* Arrays
|
||||||
|
* [Permutations](data_structures/arrays/permutations.py)
|
||||||
* Binary Tree
|
* Binary Tree
|
||||||
* [Avl Tree](data_structures/binary_tree/avl_tree.py)
|
* [Avl Tree](data_structures/binary_tree/avl_tree.py)
|
||||||
* [Basic Binary Tree](data_structures/binary_tree/basic_binary_tree.py)
|
* [Basic Binary Tree](data_structures/binary_tree/basic_binary_tree.py)
|
||||||
|
@ -291,6 +293,7 @@
|
||||||
* [Factorial](dynamic_programming/factorial.py)
|
* [Factorial](dynamic_programming/factorial.py)
|
||||||
* [Fast Fibonacci](dynamic_programming/fast_fibonacci.py)
|
* [Fast Fibonacci](dynamic_programming/fast_fibonacci.py)
|
||||||
* [Fibonacci](dynamic_programming/fibonacci.py)
|
* [Fibonacci](dynamic_programming/fibonacci.py)
|
||||||
|
* [Fizz Buzz](dynamic_programming/fizz_buzz.py)
|
||||||
* [Floyd Warshall](dynamic_programming/floyd_warshall.py)
|
* [Floyd Warshall](dynamic_programming/floyd_warshall.py)
|
||||||
* [Integer Partition](dynamic_programming/integer_partition.py)
|
* [Integer Partition](dynamic_programming/integer_partition.py)
|
||||||
* [Iterating Through Submasks](dynamic_programming/iterating_through_submasks.py)
|
* [Iterating Through Submasks](dynamic_programming/iterating_through_submasks.py)
|
||||||
|
@ -313,12 +316,16 @@
|
||||||
* [Rod Cutting](dynamic_programming/rod_cutting.py)
|
* [Rod Cutting](dynamic_programming/rod_cutting.py)
|
||||||
* [Subset Generation](dynamic_programming/subset_generation.py)
|
* [Subset Generation](dynamic_programming/subset_generation.py)
|
||||||
* [Sum Of Subset](dynamic_programming/sum_of_subset.py)
|
* [Sum Of Subset](dynamic_programming/sum_of_subset.py)
|
||||||
|
* [Viterbi](dynamic_programming/viterbi.py)
|
||||||
|
|
||||||
## Electronics
|
## Electronics
|
||||||
* [Carrier Concentration](electronics/carrier_concentration.py)
|
* [Carrier Concentration](electronics/carrier_concentration.py)
|
||||||
* [Coulombs Law](electronics/coulombs_law.py)
|
* [Coulombs Law](electronics/coulombs_law.py)
|
||||||
|
* [Electric Conductivity](electronics/electric_conductivity.py)
|
||||||
* [Electric Power](electronics/electric_power.py)
|
* [Electric Power](electronics/electric_power.py)
|
||||||
|
* [Electrical Impedance](electronics/electrical_impedance.py)
|
||||||
* [Ohms Law](electronics/ohms_law.py)
|
* [Ohms Law](electronics/ohms_law.py)
|
||||||
|
* [Resonant Frequency](electronics/resonant_frequency.py)
|
||||||
|
|
||||||
## File Transfer
|
## File Transfer
|
||||||
* [Receive File](file_transfer/receive_file.py)
|
* [Receive File](file_transfer/receive_file.py)
|
||||||
|
@ -430,6 +437,7 @@
|
||||||
## Knapsack
|
## Knapsack
|
||||||
* [Greedy Knapsack](knapsack/greedy_knapsack.py)
|
* [Greedy Knapsack](knapsack/greedy_knapsack.py)
|
||||||
* [Knapsack](knapsack/knapsack.py)
|
* [Knapsack](knapsack/knapsack.py)
|
||||||
|
* [Recursive Approach Knapsack](knapsack/recursive_approach_knapsack.py)
|
||||||
* Tests
|
* Tests
|
||||||
* [Test Greedy Knapsack](knapsack/tests/test_greedy_knapsack.py)
|
* [Test Greedy Knapsack](knapsack/tests/test_greedy_knapsack.py)
|
||||||
* [Test Knapsack](knapsack/tests/test_knapsack.py)
|
* [Test Knapsack](knapsack/tests/test_knapsack.py)
|
||||||
|
@ -622,6 +630,7 @@
|
||||||
## Matrix
|
## Matrix
|
||||||
* [Binary Search Matrix](matrix/binary_search_matrix.py)
|
* [Binary Search Matrix](matrix/binary_search_matrix.py)
|
||||||
* [Count Islands In Matrix](matrix/count_islands_in_matrix.py)
|
* [Count Islands In Matrix](matrix/count_islands_in_matrix.py)
|
||||||
|
* [Count Paths](matrix/count_paths.py)
|
||||||
* [Cramers Rule 2X2](matrix/cramers_rule_2x2.py)
|
* [Cramers Rule 2X2](matrix/cramers_rule_2x2.py)
|
||||||
* [Inverse Of Matrix](matrix/inverse_of_matrix.py)
|
* [Inverse Of Matrix](matrix/inverse_of_matrix.py)
|
||||||
* [Largest Square Area In Matrix](matrix/largest_square_area_in_matrix.py)
|
* [Largest Square Area In Matrix](matrix/largest_square_area_in_matrix.py)
|
||||||
|
@ -645,6 +654,7 @@
|
||||||
* [Back Propagation Neural Network](neural_network/back_propagation_neural_network.py)
|
* [Back Propagation Neural Network](neural_network/back_propagation_neural_network.py)
|
||||||
* [Convolution Neural Network](neural_network/convolution_neural_network.py)
|
* [Convolution Neural Network](neural_network/convolution_neural_network.py)
|
||||||
* [Perceptron](neural_network/perceptron.py)
|
* [Perceptron](neural_network/perceptron.py)
|
||||||
|
* [Simple Neural Network](neural_network/simple_neural_network.py)
|
||||||
|
|
||||||
## Other
|
## Other
|
||||||
* [Activity Selection](other/activity_selection.py)
|
* [Activity Selection](other/activity_selection.py)
|
||||||
|
@ -680,6 +690,7 @@
|
||||||
* [Newtons Law Of Gravitation](physics/newtons_law_of_gravitation.py)
|
* [Newtons Law Of Gravitation](physics/newtons_law_of_gravitation.py)
|
||||||
* [Newtons Second Law Of Motion](physics/newtons_second_law_of_motion.py)
|
* [Newtons Second Law Of Motion](physics/newtons_second_law_of_motion.py)
|
||||||
* [Potential Energy](physics/potential_energy.py)
|
* [Potential Energy](physics/potential_energy.py)
|
||||||
|
* [Sheer Stress](physics/sheer_stress.py)
|
||||||
|
|
||||||
## Project Euler
|
## Project Euler
|
||||||
* Problem 001
|
* Problem 001
|
||||||
|
@ -1089,6 +1100,7 @@
|
||||||
* [Reverse Words](strings/reverse_words.py)
|
* [Reverse Words](strings/reverse_words.py)
|
||||||
* [Snake Case To Camel Pascal Case](strings/snake_case_to_camel_pascal_case.py)
|
* [Snake Case To Camel Pascal Case](strings/snake_case_to_camel_pascal_case.py)
|
||||||
* [Split](strings/split.py)
|
* [Split](strings/split.py)
|
||||||
|
* [Text Justification](strings/text_justification.py)
|
||||||
* [Upper](strings/upper.py)
|
* [Upper](strings/upper.py)
|
||||||
* [Wave](strings/wave.py)
|
* [Wave](strings/wave.py)
|
||||||
* [Wildcard Pattern Matching](strings/wildcard_pattern_matching.py)
|
* [Wildcard Pattern Matching](strings/wildcard_pattern_matching.py)
|
||||||
|
|
Loading…
Reference in New Issue
Block a user