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 [Navigator] [Dependency Injection] Update Docs #28

Merged
merged 1 commit into from
Dec 23, 2023
Merged

Conversation

H0llyW00dzZ
Copy link
Owner

  • [+] docs(navigator): update package documentation in docs.go file

This commit updates the package documentation in the docs.go file of the navigator package. The changes include:

  • Clarifying the purpose of the package and its usage in the K8sBlackPearl project.
  • Describing the package-level Logger variable and its thread-safe access.
  • Explaining the logging functions LogInfoWithEmoji and LogErrorWithEmoji and their support for structured logging.
  • Introducing the helper function CreateLogFields for consistent structured context in logs.
  • Providing an example of how to initialize the Logger and use the logging functions.
  • Emphasizing the importance of setting the Logger before logging functions are called.
  • Noting that the use of emojis in logging functions is optional and can be customized.

Author: H0llyW00dzZ

- [+] docs(navigator): update package documentation in docs.go file

This commit updates the package documentation in the `docs.go` file of the `navigator` package. The changes include:

 - Clarifying the purpose of the package and its usage in the K8sBlackPearl project.
 - Describing the package-level Logger variable and its thread-safe access.
 - Explaining the logging functions `LogInfoWithEmoji` and `LogErrorWithEmoji` and their support for structured logging.
 - Introducing the helper function `CreateLogFields` for consistent structured context in logs.
 - Providing an example of how to initialize the Logger and use the logging functions.
 - Emphasizing the importance of setting the Logger before logging functions are called.
 - Noting that the use of emojis in logging functions is optional and can be customized.

---
Author: H0llyW00dzZ
@H0llyW00dzZ H0llyW00dzZ merged commit 1edf7b6 into master Dec 23, 2023
2 checks passed
@H0llyW00dzZ H0llyW00dzZ deleted the docs branch December 23, 2023 18:43
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant