update some out-of-date comments and documentation #176
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
dgoffredo
requested review from
zacharycmontoya
and removed request for
a team
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #176 +/- ##
==========================================
+ Coverage 93.82% 93.91% +0.09%
==========================================
Files 73 73
Lines 4176 4176
==========================================
+ Hits 3918 3922 +4
+ Misses 258 254 -4 ☔ View full report in Codecov by Sentry. |
dmehala
approved these changes
Jan 13, 2025
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
#174 had me reading through the code again.
I noticed that in a few places, comments and documentation have gotten out of sync with the source code. This PR revises a couple of comments and removes one obsolete readme file.
Also, a heads up: when building the tests on Ubuntu 24.04 with g++ 13.2, I got a spurious warning that I think is due to https://gcc.gnu.org/bugzilla/show_bug.cgi?id=109561. I built with clang++ instead (after installing libc++-dev) to work around it.
Happy 2025 🎉