Skip to content

Add an article how to implement a log handler #364

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

Merged
merged 1 commit into from
Jul 9, 2025

Conversation

FranzBusch
Copy link
Member

Motivation

In my previous PR, I overhauled the README and the DocC catalog. While doing this I removed the guidance around how to implement a log handler.

Modifications

This PR adds a DocC based guide containing the contents of the previous README guidance.

Result

Guidance around log handler implementation in a modern DocC format.

@FranzBusch FranzBusch added the semver/none No version bump required. label Jul 8, 2025
@FranzBusch FranzBusch requested a review from ktoso July 8, 2025 15:17
Copy link
Contributor

@heckj heckj left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Small wording suggestion changes, and a rework of the abstract for the article so that it doesn't include a symbol reference within it

@FranzBusch FranzBusch force-pushed the fb-implement-a-log-handler-guide branch from 9439d05 to 87bfbd2 Compare July 8, 2025 16:06
@FranzBusch FranzBusch requested a review from heckj July 8, 2025 16:06
Copy link
Contributor

@heckj heckj left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

minor header level changes to make the levels more consistent as an article, and a suggestion to shift the "performance considerations" higher up on the article.

I'd also recommend merging #363 first, rebasing this, and then included it into the top-level page as an article reference, as without it - it'll be sort of buried beneath everything else.

@FranzBusch FranzBusch requested a review from heckj July 9, 2025 14:49
# Motivation

In my previous PR, I overhauled the README and the DocC catalog. While doing this I removed the guidance around how to implement a log handler.

# Modifications

This PR adds a DocC based guide containing the contents of the previous README guidance.

# Result

Guidance around log handler implementation in a modern DocC format.
@FranzBusch FranzBusch force-pushed the fb-implement-a-log-handler-guide branch from 87bfbd2 to 5e47710 Compare July 9, 2025 14:51
@FranzBusch FranzBusch requested a review from czechboy0 July 9, 2025 14:51
Copy link
Contributor

@czechboy0 czechboy0 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks great

@FranzBusch FranzBusch merged commit cbd28c2 into apple:main Jul 9, 2025
31 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
semver/none No version bump required.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants