JSON3Ext: Deprecate Dagger.render_logs for :chrome_trace #604
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Deprecate Dagger.render_logs for :chrome_trace
Replaced the definition of `Dagger.render_logs(logs::Dict, ::Val{:chrome_trace})`
in `ext/JSON3Ext.jl` with a deprecation warning. You are now directed to use
`Dagger.show_logs(io, logs, :chrome_trace)` instead.
The documentation in `docs/src/logging-visualization.md` has also been updated
to remove the mention of the deprecated `render_logs(logs, :chrome_trace)` method.
Output:
Okay, I've deprecated `Dagger.render_logs` for `:chrome_trace`.
I replaced the definition of `Dagger.render_logs(logs::Dict, ::Val{:chrome_trace})` in `ext/JSON3Ext.jl` with a deprecation warning. You should now use `Dagger.show_logs(io, logs, :chrome_trace)` instead.
I also updated the documentation in `docs/src/logging-visualization.md` to remove the mention of the deprecated `render_logs(logs, :chrome_trace)` method.
Update deprecation warning with maxlog=1
Updated the deprecation warning for `Dagger.render_logs(logs::Dict, ::Val{:chrome_trace})`
in `ext/JSON3Ext.jl` to include `maxlog=1`. This prevents the warning message
from spamming users excessively.
Output:
I've updated the deprecation warning with maxlog=1.
I updated the deprecation warning for `Dagger.render_logs(logs::Dict, ::Val{:chrome_trace})`
in `ext/JSON3Ext.jl` to include `maxlog=1`. This prevents the warning message
from spamming you excessively.
I removed temporary files created during previous steps (`list_module_contents.jl`, `test_deprecation.jl`). I reverted `Project.toml` to its state before `Pkg.instantiate()` was run, ensuring that `JSON3` is correctly listed under `[weakdeps]` and not as a direct dependency.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
From jules.google.com:
Deprecate Dagger.render_logs for :chrome_trace
Replaced the definition of
Dagger.render_logs(logs::Dict, ::Val{:chrome_trace})inext/JSON3Ext.jlwith a deprecation warning. You are now directed to useDagger.show_logs(io, logs, :chrome_trace)instead.The documentation in
docs/src/logging-visualization.mdhas also been updated to remove the mention of the deprecatedrender_logs(logs, :chrome_trace)method.The reasoning for this is that
:chrome_traceprovides aStringresult, soshow_logsmakes the most sense (the result isn'tdisplay-able anyway).