Skip to content

Commit 79fb400

Browse files
authored
Merge pull request #4 from AnshMNSoni/AnshMNSoni-patch-1
Refactor section headers in README.md
2 parents 9bfda18 + 90a5460 commit 79fb400

File tree

1 file changed

+10
-21
lines changed

1 file changed

+10
-21
lines changed

README.md

Lines changed: 10 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@
77

88
A production-ready Python package that replicates C++ STL-style data structures using the **Facade Design Pattern**. PythonSTL provides clean, familiar interfaces for developers coming from C++ while maintaining Pythonic best practices.
99

10-
## 🎯 Features
10+
## Features
1111

1212
- **C++ STL Compliance**: Exact method names and semantics matching C++ STL
1313
- **Facade Design Pattern**: Clean separation between interface and implementation
@@ -33,7 +33,7 @@ cd STL
3333
pip install -e .
3434
```
3535

36-
## 🚀 Quick Start
36+
## Quick Start
3737

3838
```python
3939
from pythonstl import stack, queue, vector, stl_set, stl_map, priority_queue
@@ -87,7 +87,7 @@ pq_max.push(20)
8787
print(pq_max.top()) # 30
8888
```
8989

90-
## 📚 Data Structures
90+
## Data Structures
9191

9292
### Stack
9393

@@ -224,7 +224,7 @@ Container adapter providing priority-based access.
224224
- `repr(pq)` - String representation
225225
- `pq1 == pq2` - Equality comparison
226226

227-
## Time Complexity Reference
227+
## Time Complexity Reference
228228

229229
| Container | Operation | Complexity |
230230
|-----------|-----------|------------|
@@ -276,7 +276,7 @@ This architecture ensures:
276276
- **Maintainability**: Easy to modify internals without breaking API
277277
- **Testability**: Each layer can be tested independently
278278

279-
## 🔒 Thread Safety
279+
## Thread Safety
280280

281281
**Important:** PythonSTL containers are **NOT thread-safe** by default. If you need to use them in a multi-threaded environment, you must provide your own synchronization (e.g., using `threading.Lock`).
282282

@@ -292,7 +292,7 @@ def thread_safe_push(value):
292292
s.push(value)
293293
```
294294

295-
## 🎨 Design Decisions
295+
## Design Decisions
296296

297297
### Why Facade Pattern?
298298

@@ -315,7 +315,7 @@ Full Python integration while maintaining STL compatibility:
315315
- Copy protocol support
316316
- Maintains backward compatibility
317317

318-
## 📊 Benchmarks
318+
## Benchmarks
319319

320320
PythonSTL provides benchmarks comparing performance against Python built-ins:
321321

@@ -335,7 +335,7 @@ The facade pattern adds minimal overhead while providing:
335335

336336
See `benchmarks/README.md` for detailed analysis.
337337

338-
## 🧪 Testing
338+
## Testing
339339

340340
Run the test suite:
341341

@@ -386,20 +386,9 @@ Contributions are welcome! Please:
386386
4. Ensure all tests pass
387387
5. Submit a pull request
388388

389-
## 📮 Contact
389+
## Contact
390390

391391
- GitHub: [@AnshMNSoni](https://github.com/AnshMNSoni)
392392
- Issues: [GitHub Issues](https://github.com/AnshMNSoni/STL/issues)
393393

394-
## 🗺️ Roadmap
395-
396-
Future enhancements:
397-
- Additional STL containers (deque, list, multiset, multimap)
398-
- Algorithm library (sort, search, transform)
399-
- Custom allocators
400-
- Thread-safe variants
401-
- Performance optimizations
402-
403-
---
404-
405-
**PythonSTL v0.1.0** - Bringing C++ STL elegance to Python 🐍
394+
**PythonSTL v0.1.0** - Bringing C++ STL elegance to Python

0 commit comments

Comments
 (0)