Skip to content

Commit 6b16eba

Browse files
authored
doc: remind users that versioninfo may include secrets (#43839)
Add a warning to the docstring of `InteractiveUtils.versioninfo()` reminding users to remove sensitive information before sharing the output text.
1 parent a84a058 commit 6b16eba

File tree

1 file changed

+4
-0
lines changed

1 file changed

+4
-0
lines changed

stdlib/InteractiveUtils/src/InteractiveUtils.jl

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -85,6 +85,10 @@ controlled with boolean keyword arguments:
8585
8686
- `verbose`: print all additional information
8787
88+
!!! warning "Warning"
89+
The output of this function may contain sensitive information. Before sharing the output,
90+
please review the output and remove any data that should not be shared publicly.
91+
8892
See also: [`VERSION`](@ref).
8993
"""
9094
function versioninfo(io::IO=stdout; verbose::Bool=false)

0 commit comments

Comments
 (0)