Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Documentation for memory.h (#371) #461

Merged
merged 1 commit into from
Oct 7, 2024

Conversation

Testspieler09
Copy link
Contributor

I added documentation for all 4 private functions of memory.h. I hope this helps and would be thankful for any feedback

Referring to issue: #371

- added documentation for all private functions of memory.h
@goatshriek goatshriek self-assigned this Oct 6, 2024
Copy link

codecov bot commented Oct 6, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 90.53%. Comparing base (1bd3333) to head (b55ff89).
Report is 2 commits behind head on latest.

Additional details and impacted files
@@            Coverage Diff             @@
##           latest     #461      +/-   ##
==========================================
+ Coverage   90.35%   90.53%   +0.18%     
==========================================
  Files          47       47              
  Lines        4374     4374              
  Branches      586      586              
==========================================
+ Hits         3952     3960       +8     
+ Misses        287      280       -7     
+ Partials      135      134       -1     

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@goatshriek
Copy link
Owner

At a glance this looks good! You can disregard coverage and the codecov failures for this - they aren't caused by your change. When I have a little more time available I'll give this a more thorough review and then either request changes or merge it in.

@goatshriek goatshriek added the documentation documentation updates label Oct 6, 2024
@goatshriek goatshriek merged commit afdc224 into goatshriek:latest Oct 7, 2024
56 checks passed
@goatshriek
Copy link
Owner

Excellent work on these, particularly in considering the POSIX safety concepts and documenting them appropriately. This documentation is much appreciated!

@goatshriek goatshriek added the hacktoberfest-accepted accepted work that is valid for hacktoberfest label Oct 7, 2024
@Testspieler09 Testspieler09 deleted the further_documentation branch October 7, 2024 09:41
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation documentation updates hacktoberfest-accepted accepted work that is valid for hacktoberfest
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants