Skip to content

Commit 5ccb2d2

Browse files
authored
feat(ErdosProblems): Add Erdos README (#2407)
1 parent 99c3b38 commit 5ccb2d2

File tree

1 file changed

+48
-0
lines changed

1 file changed

+48
-0
lines changed
Lines changed: 48 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,48 @@
1+
# Erdős Problems
2+
3+
The official list of Erdős problems can be found at [erdosproblems.com](https://www.erdosproblems.com), managed by Thomas Bloom.
4+
5+
The purpose of this README is to standardize Lean formalization rules for Erdős problems. These standards will make it easier for new contributors to navigate the various formalizations within this repository.
6+
7+
## Naming Theorems
8+
An Erdős problem usually consists of two parts:
9+
1. **The main problem(s)**: The text within the red or green box on the website.
10+
2. **The additional text**: The text provided below the red or green box.
11+
12+
### Main Problem(s)
13+
Main problems may be presented as single questions, multi-part questions, requests for boundary estimates, or descriptions of functional behavior. Use the following naming standards for each case:
14+
15+
* **Single Questions**
16+
Use the format: `erdos_{N}`
17+
18+
* **Multi-part Questions**
19+
Use the convention: `erdos_{N}.parts.i`, `erdos_{N}.parts.ii`, etc.
20+
*(Note: In this case, there will not be a standalone `erdos_{N}` theorem.)*
21+
22+
* **Estimate Questions**
23+
The standard pattern is: `erdos_{N}.lower_bound` and `erdos_{N}.upper_bound`
24+
*Note: If a strict equality is proven, use `erdos_{N}`.*
25+
26+
* **Behavioral Descriptions**
27+
We do not currently have a standardized example for this case.
28+
29+
### Additional Text
30+
For variants found in the additional text, the naming convention is:
31+
`erdos_{N}.variants.{name}`
32+
33+
Choose a name that is descriptive of the variant. A common case is when the variant is a solved case for the main problem, but only for `k \geq 2`. In this case, the name could be `erdos_{N}.variants.k_geq_2`. Another common case is when a variant of the main problem is conjectured by another author. In this case, the name could be `erdos_{N}.variants.{author}`.
34+
35+
## Docstrings
36+
Please keep docstrings as close as possible to the text on the Erdős Problems website. You should generally be able to copy and paste the LaTeX statements into the docstrings with only minor formatting adjustments.
37+
38+
## References
39+
If the website lists references, include them at the top of the file and reference them via their citation. You can copy these directly from the "View the LaTeX source" section of the website.
40+
An example of this would be:
41+
42+
**Example**:
43+
```
44+
*References:*
45+
- [erdosproblems.com/{N}](https://www.erdosproblems.com/{N})
46+
- [Va99] Various, Some of Paul's favorite problems. Booklet produced for the conference "Paul Erdős
47+
and his mathematics", Budapest, July 1999 (1999).
48+
```

0 commit comments

Comments
 (0)