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

docs(package): add missing docs #43

Merged
merged 6 commits into from
Jul 27, 2023
Merged

Conversation

bismapervaiz
Copy link
Contributor

@bismapervaiz bismapervaiz commented Jul 27, 2023

What

This PR adds missing documentation for the package files in the Go project.

Why

The documentation is essential for improving code readability, maintainability, and enabling other developers to understand the package's functionality and usage.

Type of change

Select multiple if applicable.

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause a breaking change)
  • Tests (adds or updates tests)
  • Documentation (adds or updates documentation)
  • Refactor (style improvements, performance improvements, code refactoring)
  • Revert (reverts a commit)
  • CI/Build (adds or updates a script, change in external dependencies)

Dependency Change

N/A

Breaking change

No breaking changes introduced in this PR.

Testing

Testing wasn't required since no changes were introduced in the code.

Checklist

  • My code follows the coding conventions
  • I have performed a self-review of my own code
  • I have commented my code, particularly in hard-to-understand areas
  • I have added new unit tests

@bismapervaiz bismapervaiz added documentation Improvements or additions to documentation priority-medium labels Jul 27, 2023
@bismapervaiz bismapervaiz self-assigned this Jul 27, 2023
@bismapervaiz bismapervaiz linked an issue Jul 27, 2023 that may be closed by this pull request
@bismapervaiz bismapervaiz merged commit f35951a into main Jul 27, 2023
1 check passed
@asadali214 asadali214 deleted the 41-add-missing-documentation branch March 26, 2024 03:19
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation priority-medium
Projects
None yet
Development

Successfully merging this pull request may close these issues.

[DOCUMENTATION] Add Missing Documentation
2 participants