NotificationsYou must be signed in to change notification settings
Fork2.8k
Star18.1k

Exclude code blocks that aren't run#5307

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 ourterms of service andprivacy statement. We’ll occasionally send you account related emails.

Already on GitHub?Sign in to your account

Jump to bottom

Merged

gvwilson merged 2 commits intomkdocs-conversionfromupdate-script

Jul 31, 2025

Merged

Exclude code blocks that aren't run#5307

gvwilson merged 2 commits intomkdocs-conversionfromupdate-script

Jul 31, 2025

Conversation

Copy link

Member

LiamConnors commentedJul 30, 2025

In the docs we have Python code which is formatted as Python code

but not run. In the Markdown it looks like this, it's inside blocks:

<!-- #region -->Code that relied on the `add_*` methods to return a reference to the newly created trace will need to be updated to access the trace from the returned figure.  This can be done by appending `.data[-1]` to the add trace expression.Here is an example of a version 3 code snippet that adds a scatter trace to a figure, assigns the result to a variable named `scatter`, and then modifies the marker size of the scatter trace.```pythonimport plotly.graph_objs as gofig = go.Figure()scatter = fig.add_trace(go.Scatter(y=[2, 3, 1]))scatter.marker.size = 20

In version 4, this would be replaced with the following:

importplotly.graph_objectsasgofig=go.Figure()scatter=fig.add_trace(go.Scatter(y=[2,3,1])).data[-1]scatter.marker.size=20

This PR modifies the `run_markdown.py` script to not run these sections. Also updates the test script to use the same function as `run_markdown.py` uses