Skip to content

Commit 7233a2a

Browse files
docs: remove duplicate algorithm guidelines
1 parent 6e03a48 commit 7233a2a

1 file changed

Lines changed: 1 addition & 15 deletions

File tree

‎CONTRIBUTING.md‎

Lines changed: 1 addition & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -53,7 +53,7 @@ An algorithm is one or more functions (or classes) that:
5353

5454
Algorithms should be packaged in a way that would make it easy for readers to integrate them into larger programs.
5555

56-
Algorithms should:
56+
#### Algorithms should:
5757

5858
- have intuitive class and function names that make their purpose clear to readers,
5959
- use Python naming conventions and intuitive variable names to ease comprehension,
@@ -67,20 +67,6 @@ Algorithms should:
6767
Algorithms in this repo should not be simple how-to examples for existing Python packages. Instead, they should perform internal calculations or manipulations to convert input values into different output values.
6868
These calculations or manipulations can use data types, classes, or functions of existing Python packages, but each algorithm in this repo should add unique value.
6969

70-
#### Pre-Commit Plugin
71-
72-
- have intuitive class and function names that make their purpose clear to readers
73-
- use Python naming conventions and intuitive variable names to ease comprehension
74-
- be flexible to take different input values
75-
- have Python type hints for their input parameters and return values
76-
- raise Python exceptions (`ValueError`, etc.) on erroneous input values
77-
- have docstrings with clear explanations and/or URLs to source materials
78-
- contain doctests that test both valid and erroneous input values
79-
- return all calculation results instead of printing or plotting them
80-
81-
Algorithms in this repo should not be how-to examples for existing Python packages. Instead, they should perform internal calculations or manipulations to convert input values into different output values.
82-
Those calculations or manipulations can use data types, classes, or functions of existing Python packages, but each algorithm in this repo should add unique value.
83-
8470
#### Pre-commit
8571

8672
Use [pre-commit](https://pre-commit.com/#installation) to automatically format your code to match our coding style:

0 commit comments

Comments
 (0)