Skip to content

Add a doc reference that helps identify the possible values for Logger :translator_inspect_opts #14420

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

Conversation

satom99
Copy link
Contributor

@satom99 satom99 commented Apr 10, 2025

I came across the Logger runtime config param :translator_inspect_opts and there is no mention in the docs of what are the allowed options. I had to look through the source code to figure out that these options are later passed to a call to Kernel.inspect/2.

This PR helps remediate that by adding a reference to the docs for Kernel.inspect/2 in the documentation of the runtime config param :translator_inspect_opts. We could link to the Inspect.Opts module directly perhaps, but I figured that this can be a problem if for any reason the Kernel.inspect/2 function changes its spec at some point, and/or the options are moved elsewhere.

@josevalim josevalim merged commit db6c536 into elixir-lang:main Apr 10, 2025
@josevalim
Copy link
Member

💚 💙 💜 💛 ❤️

@satom99 satom99 deleted the refer-to-kernel-inspect-in-Logger-runtime-config-translator_inspect_opts branch April 10, 2025 09:56
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Development

Successfully merging this pull request may close these issues.

2 participants