Skip to content

Commit fbb8c3b

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

File tree

2 files changed

+40
-33
lines changed

2 files changed

+40
-33
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: 37 additions & 32 deletions
Original file line numberDiff line numberDiff line change
@@ -3,48 +3,53 @@
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.
10-
11-
## Language Details:
12-
- [language reference](https://docs.python.org/3.11/reference/index.html#reference*index)
13-
- [interpreter:](https://github.com/python/cpython)
14-
- [Bennett, J. 2019. See CPython run: Getting to know your Python interpreter. North Bay Python](https://www.youtube.com/watch?v=tzYhv61piNY)
15-
- [base modules index](https://docs.python.org/3/py-modindex.html)
16-
- [standard library reference](https://docs.python.org/3.11/library/index.html)
17-
- [packaging and distribution](https://packaging.python.org/en/latest/)
18-
- [python packaging authority](https://www.pypa.io/en/latest/)
19-
- [glossary](https://packaging.python.org/en/latest/glossary/)
20-
- tools:
21-
- [pip](https://pypi.org/project/pip/)
22-
- [pipenv](https://pipenv.pypa.io/en/latest/)
23-
- structuring projects:
24-
- [package index](https://pypi.org)
25-
- [extending and embedding](https://docs.python.org/3.11/extending/index.html)
26-
- [developer contribution guide](https://devguide.python.org/)
27-
- memory model:
28-
- [computational complexity cost model](https://ocw.mit.edu/courses/6-006-introduction-to-algorithms-fall-2011/pages/readings/python-cost-model/)
29-
- history:
30-
- [The Story of Python, by Its Creator, Guido van Rossum](https://www.youtube.com/watch?v=J0Aq44Pze-w)
31-
32-
## Testing:
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.
11+
12+
## Language Details
13+
- [language reference](https://docs.python.org/3.11/reference/index.html#reference*index)
14+
- [interpreter:](https://github.com/python/cpython)
15+
- [Bennett, J. 2019. See CPython run: Getting to know your Python interpreter. North Bay Python](https://www.youtube.com/watch?v=tzYhv61piNY)
16+
- [base modules index](https://docs.python.org/3/py-modindex.html)
17+
- [standard library reference](https://docs.python.org/3.11/library/index.html)
18+
- [packaging and distribution](https://packaging.python.org/en/latest/)
19+
- [python packaging authority](https://www.pypa.io/en/latest/)
20+
- [glossary](https://packaging.python.org/en/latest/glossary/)
21+
- tools:
22+
- [pip](https://pypi.org/project/pip/)
23+
- [pipenv](https://pipenv.pypa.io/en/latest/)
24+
- structuring projects:
25+
- [package index](https://pypi.org)
26+
- [extending and embedding](https://docs.python.org/3.11/extending/index.html)
27+
- [developer contribution guide](https://devguide.python.org/)
28+
- memory model:
29+
- [computational complexity cost model](https://ocw.mit.edu/courses/6-006-introduction-to-algorithms-fall-2011/pages/readings/python-cost-model/)
30+
- history:
31+
- [The Story of Python, by Its Creator, Guido van Rossum](https://www.youtube.com/watch?v=J0Aq44Pze-w)
32+
33+
## Testing
3334
- [pytest](https://docs.pytest.org/en/latest/index.html#)
3435

35-
## Use Cases:
36-
- [Applications for Python](https://www.python.org/about/apps/)
36+
## Use Cases
37+
- [Applications of 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-
43+
## Spell Check
4444
```shell
4545
pyspelling -c spellcheck.yaml
4646
```
4747

4848
# References:
4949

50+
## Legend:
51+
**Q**: Question for later research
52+
53+
**MYINC**: My Insight/Conjecture [Could Be Unoriginal/False and Likely Is]
54+
5055
**Disclaimer**: This is an ongoing and incomplete project to unpack these concepts and serve as my distributed memory.

0 commit comments

Comments
 (0)