Python
Python copied to clipboard
Updated docs for bit manipluation
Describe your change:
I have comprehensively updated the documentation within the bit_manipulation subdirectory to ensure consistency across all files. Given that bitwise operations are inherently abstract and difficult to parse without context, I focused on adding detailed explanations and practical examples. This standardization aims to demystify the internal logic (such as shifting and masking) and significantly improve the learning curve for beginners. I did all the files, because I wanted consistency across the directory
- [ ] Add an algorithm?
- [ ] Fix a bug or typo in an existing algorithm?
- [ ] Add or change doctests?
- [x] Documentation change?
Checklist:
- [x] I have read CONTRIBUTING.md.
- [x] This pull request is all my own work -- I have not plagiarized.
- [x] I know that pull requests will not be merged if they fail the automated tests.
- [] This PR only changes one algorithm file.
- [x] All new Python files are placed inside an existing directory.
- [x] All filenames are in all lowercase characters with no spaces or dashes.
- [x] All functions and variable names follow Python naming conventions.
- [x] All function parameters and return values are annotated with Python type hints.
- [x] All functions have doctests that pass automated testing.
- [x] All new algorithms include at least one URL that points to source material.