[gnutls-devel] GnuTLS | Fix: Add missing parameter documentation in lib/audit.c (!2035)

[Read-only notification of GnuTLS library development activities]

Karthik Das created a merge request: https://gitlab.com/gnutls/gnutls/-/merge_requests/2035

Project:Branches: devkdas/gnutls:master to gnutls/gnutls:master
Author:   Karthik Das



<!-- Add a description of the new feature/bug fix. Reference any relevant bugs. -->
This is a concise and informative message that clearly describes the change. It follows the conventional commit format, which is widely used in software development.

Here's a breakdown of why this is a good commit message:

Fix: This prefix indicates that the commit is a bug fix. In this case, it's fixing a documentation build error.
Add missing parameter documentation: This is a brief and accurate description of the change. It clearly states what was done.
in lib/audit.c: This specifies the location of the change, making it easy for other developers to find and understand the context of the commit.
Using a well-structured and descriptive commit message is essential for maintaining a clean and understandable version history. It helps other developers (and your future self) to quickly grasp the purpose of each change without having to delve into the code.

* Add missing parameter documentation in lib/audit.c

## Checklist
 * [ ] Commits have `Signed-off-by:` with name/author being identical to the commit author
 * [ ] Code modified for feature
 * [ ] Test suite updated with functionality tests
 * [ ] Test suite updated with negative tests
 * [ ] Documentation updated / NEWS entry present (for non-trivial changes)

## Reviewer's checklist:
 * [ ] Any issues marked for closing are addressed
 * [ ] There is a test suite reasonably covering new functionality or modifications
 * [ ] Function naming, parameters, return values, types, etc., are consistent and according to `CONTRIBUTION.md`
 * [ ] This feature/change has adequate documentation added
 * [ ] No obvious mistakes in the code

-- 
Reply to this email directly or view it on GitLab: https://gitlab.com/gnutls/gnutls/-/merge_requests/2035
You're receiving this email because of your account on gitlab.com.


-------------- next part --------------
An HTML attachment was scrubbed...
URL: <https://lists.gnupg.org/pipermail/gnutls-devel/attachments/20251030/c7a2cbba/attachment-0001.html>