Skip to content

docs: match description of debug option with behavior since #820 #860

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

Conversation

AlexTMjugador
Copy link
Contributor

@AlexTMjugador AlexTMjugador commented Jul 7, 2025

PR #820 removed the debug-logs crate feature, but failed to update the documentation for the related debug field in the client options struct, which now falsely asserts that the log feature changes the behavior of the sentry_debug! macro.

This change fixes that discrepancy by removing all references to features in the documentation for that field.

PR #820 removed the `debug-logs` crate feature, but failed to update the
documentation for the related `debug` field in the client options
struct, which falsely asserts that the `log` feature changes the
behavior of the `sentry_debug!` macro.

This change fixes that discrepancy by removing any reference to features
in the documentation for that field.
@AlexTMjugador
Copy link
Contributor Author

AlexTMjugador commented Jul 7, 2025

I just noticed that a workflow running DangerJS on this PR complained due to it not including a changelog entry. I believe this change is trivial enough not to require one, and added a #skip-changelog tag to the PR description accordingly, but please let me know if you feel differently. I'm happy to update the PR if needed 🙏

@lcian
Copy link
Member

lcian commented Jul 7, 2025

Thanks @AlexTMjugador!
Yeah I think #skip-changelog is fine for this, however if you add a changelog entry (which should include your username tag) you will appear in the contributors for the release
Screenshot 2025-07-07 at 13 25 48
So if you care about this feel free to add it ^^

While at it, I got rid of a trailing extra whitespace in a header.
@AlexTMjugador
Copy link
Contributor Author

The idea of getting some extra exposure has convinced me to add a changelog entry! 😂 I've just done that 🙂

@lcian
Copy link
Member

lcian commented Jul 7, 2025

The idea of getting some extra exposure has convinced me to add a changelog entry! 😂 I've just done that 🙂

Nice :)

@lcian lcian enabled auto-merge (squash) July 7, 2025 11:56
@lcian lcian merged commit f247ac0 into getsentry:master Jul 7, 2025
16 checks passed
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.

2 participants