Skip to content

Commit 02aa6b6

Browse files
committed
docs: constistent docs across repos.
1 parent 55ddbe9 commit 02aa6b6

File tree

2 files changed

+13
-10
lines changed

2 files changed

+13
-10
lines changed

.gitignore

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -160,4 +160,6 @@ cython_debug/
160160
#.idea/
161161

162162
.DS_Store
163-
.vscode
163+
.vscode
164+
165+
tools/

README.md

Lines changed: 10 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -3,12 +3,13 @@
33
[![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black)
44
![build status](https://github.com/praisetompane-programming-languages/python/actions/workflows/python.yaml/badge.svg) <br>
55

6-
**objective**: An in-depth study of:
7-
- Python's Interpreter:
8-
- This focuses on [CPython](https://github.com/python/cpython).
9-
- Python's language design, implementation and ecosystem.
6+
## Objectives
7+
- An in-depth study of Python's:
8+
- Interpreter.
9+
- This focuses on [CPython](https://github.com/python/cpython).
10+
- Python's design, implementation and ecosystem.
1011

11-
## Language Details:
12+
## Language Details
1213
- [language reference](https://docs.python.org/3.11/reference/index.html#reference*index)
1314
- [interpreter:](https://github.com/python/cpython)
1415
- [Bennett, J. 2019. See CPython run: Getting to know your Python interpreter. North Bay Python](https://www.youtube.com/watch?v=tzYhv61piNY)
@@ -29,17 +30,17 @@
2930
- history:
3031
- [The Story of Python, by Its Creator, Guido van Rossum](https://www.youtube.com/watch?v=J0Aq44Pze-w)
3132

32-
## Testing:
33+
## Testing
3334
- [pytest](https://docs.pytest.org/en/latest/index.html#)
3435

35-
## Use Cases:
36+
## Use Cases
3637
- [Applications for Python](https://www.python.org/about/apps/)
3738

38-
## Learning Resources:
39+
## Learning Resources
3940
- [roadmap](https://roadmap.sh/python)
4041
- [practice problems](https://www.hackerrank.com/domains/python?filters%5Bstatus%5D%5B%5D=unsolved&badge_type=python)
4142

42-
## Spell Check:
43+
## Spell Check
4344

4445
```shell
4546
pyspelling -c spellcheck.yaml

0 commit comments

Comments
 (0)