Skip to content

Commit

Permalink
doc: remind users that versioninfo may include secrets (JuliaLang#43839)
Browse files Browse the repository at this point in the history
Add a warning to the docstring of `InteractiveUtils.versioninfo()`
reminding users to remove sensitive information before sharing the
output text.
  • Loading branch information
DilumAluthge authored and LilithHafner committed Feb 22, 2022
1 parent c27f4f2 commit dfa3aba
Showing 1 changed file with 4 additions and 0 deletions.
4 changes: 4 additions & 0 deletions stdlib/InteractiveUtils/src/InteractiveUtils.jl
Original file line number Diff line number Diff line change
Expand Up @@ -85,6 +85,10 @@ controlled with boolean keyword arguments:
- `verbose`: print all additional information
!!! warning "Warning"
The output of this function may contain sensitive information. Before sharing the output,
please review the output and remove any data that should not be shared publicly.
See also: [`VERSION`](@ref).
"""
function versioninfo(io::IO=stdout; verbose::Bool=false)
Expand Down

0 comments on commit dfa3aba

Please sign in to comment.