Attempting to Merge main into Documentation
#256
Conversation
Co-authored-by: Nate Gay <[email protected]>
Co-authored-by: Alan De La Torre <[email protected]>
Co-authored-by: Copilot <[email protected]>
…rate sleep durations (#243) Co-authored-by: SSL-Rey <[email protected]>
Co-authored-by: Nate Gay <[email protected]> Co-authored-by: Nate Gay <[email protected]>
Also had to remove: Could not determine a constructor for the tag 'tag:yaml.org,2002:python/name:pymdownx.emoji.gemoji' in "pysquared/mkdocs.yml", line 85, column 20
There was a problem hiding this comment.
Pull Request Overview
This PR syncs the Documentation branch with the latest changes from main while adding new mocks, updating doc guides, and modifying build and CI configurations.
- Added several new mock implementations for various hardware components.
- Removed legacy files (e.g., config.json, older adafruit_rfm mocks) and updated documentation and build scripts.
Reviewed Changes
Copilot reviewed 123 out of 123 changed files in this pull request and generated no comments.
Show a summary per file
| File | Description |
|---|---|
| mocks/proves_sx126/sx126x.py | New mock file defining constants for SX126. |
| mocks/proves_sx126/sx1262.py | New mock file introducing the SX1262 class interface. |
| mocks/circuitpython/rtc.py | Updated RTC mock with a new datetime attribute. |
| mocks/circuitpython/byte_array.py | Refactored ByteArray with modified setitem signature. |
| mocks/circuitpython/adafruit_rfm/* | Removed legacy adafruit_rfm mocks from circuitpython folder. |
| mocks/adafruit_rfm/* | Added updated mocks for Adafruit RFM components. |
| mocks/adafruit_lsm6ds/lsm6dsox.py, lis2mdl.py, ina219.py | New mocks for sensor and power monitor components. |
| lib/requirements.txt | Removed the requirements file, likely shifting dependency management. |
| docs/dev-guide.md | Updated documentation with clearer installation instructions. |
| README.md | Revised repo title and supported boards section. |
| Makefile | Updated build, typecheck, and clean targets for improved consistency. |
| .pre-commit-config.yaml & .github/workflows/ci.yaml | Minor adjustments to pre-commit and CI configurations. |
…eating markdown files for them.
There was a problem hiding this comment.
Thank you so much for catching up the documentation branch with current main!!
- For the main modules, I added more in depth comments in a uniform format explaining the purposes of each module, their methods, function attributes, function return values, and error catching. These comments serve as the base for the contents of the markdown pages.
Start Up:
- cd pysquared> cd pysquared
- mkdocs build -> builds html based on markdown files in pysquared/pysquared/docs
- mkdocs serve -> hosts html files on localhost
- Feel free to leave any feedback on if any comments are poorly describing any particular behavior in the modules.
- Please leave any extra notes and details that you think should be included to best describe the quirks of the logic of modules, circuitpython, hardware, etc and give good context to modules.
- I know we all touch a lot of different places in the repo but if there are any places where people can be credited as authors please let me know.
Notes:
- This documentation doesn't cover the new managers, mocks, or tests.
- I left packet_manager and packet_sender alone (no new comments or markdown pages) because I know Nate is making changes to those files right now.
There was a problem hiding this comment.
I'll take a look at the documentation specific stuff when I get a chance, but I think those make typecheck errors do need to be looked at. I get no errors or warnings whenever I run make typecheck on main, so I think something may have been merged incorrectly. (They all come from cdh.py)
|
Hey @TaylorGilg thanks for the slight rollback on Just as a heads up, I did just open #257 with some additional unit tests to try and get the SonarCloud quality gate over that 80% line on this! Let me know what you think about it |
Signed-off-by: Michael Pham <[email protected]> Co-authored-by: Copilot <[email protected]>
|
Summary
Taylor is doing some great work getting docstrings into the code base and setting things up for automatic generation of the docs site!
I noticed that the Documentation branch was becoming quite behind compared to
mainand took some time to get everything caught up! The number of changes at play here is pretty disgusting tbh, but I think it's either we do a big update now or get wrecked later when we try to merge back intomainhaha.I think all of the conflicts with the contents of the actual code files are reflecting what is on
mainand abandoning anything that was in this branch. Any documentation files override what was onmainand accept what is inDocumentation.How was this tested
There are still a ton of
typecheckerrors, but I think these are present onmainso it's an upstream problem to solve.