Minor WaveDrom rendering fixes and improvements#486
Open
fdxmw wants to merge 1 commit into
Open
Conversation
Codecov Report❌ Patch coverage is
Additional details and impacted files@@ Coverage Diff @@
## development #486 +/- ##
=============================================
+ Coverage 92.0% 92.0% +0.1%
=============================================
Files 30 30
Lines 7439 7428 -11
=============================================
- Hits 6837 6828 -9
+ Misses 602 600 -2 ☔ View full report in Codecov by Harness. 🚀 New features to boost your workflow:
|
* Rename `trace_to_html` to `trace_to_json`, and generalize the function so it just returns WaveJSON, which can be used by many different tools. Previously, `trace_to_html` returned HTML-embeddable WaveJSON, which is only useful for building a webpage. * Improve documentation for `trace_to_json` and add a doctest example. * Update `render_trace` to pass `repr_func` and `repr_per_name` to `trace_to_json`, to support custom data formatting in Jupyter notebooks. Many examples rely on these features. * Display cycle numbers above traces for consistency with the console renderer. * Fix example8's deprecated call to `render_trace` (pass wire names instead of `WireVector`s). * Use `json.dumps` in `trace_to_json` instead of doing JSON string formatting ourselves. * Move `val_to_str` to module-level, so it can be called from `trace_to_json`. Simplify `val_to_str`'s implementation. * Remove `renderer-demo` from `ipynb-examples`. The different rendering options only work for the console renderer.
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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.
trace_to_htmltotrace_to_json, and generalize the function so it just returns WaveJSON, which can be used by many different tools. Previously,trace_to_htmlreturned HTML-embeddable WaveJSON, which is only useful for building a webpage.trace_to_jsonand add a doctest example.render_traceto passrepr_funcandrepr_per_nametotrace_to_json, to support custom data formatting in Jupyter notebooks. Many examples rely on these features.render_trace(pass wire names instead ofWireVectors).json.dumpsintrace_to_jsoninstead of doing JSON string formatting ourselves.val_to_strto module-level, so it can be called fromtrace_to_json. Simplifyval_to_str's implementation.renderer-demofromipynb-examples. The different rendering options only work for the console renderer.