Skip to content

docs: fix broken cross-page anchors and tile density heatmap links - #5810

Open
SatvikMishra08 wants to merge 1 commit into
plotly:doc-prodfrom
SatvikMishra08:docs/fix-anchor-links
Open

SatvikMishra08 wants to merge 1 commit into
plotly:doc-prodfrom
SatvikMishra08:docs/fix-anchor-links

Conversation

@SatvikMishra08

Copy link
Copy Markdown

Fixes broken in-page and cross-page links in the Python docs (24 files).

The published docs at plotly.com/python generate heading anchors that keep the heading's original casing and punctuation (for example #Magic-Underscore-Notation, #2D-Cartesian-Trace-Types-and-Subplots), so many lowercase anchors in the markdown no longer jump to their section. This updates 35 of those anchors to match the live pages.

It also fixes 3 links to the old /python/tile-density-heatmaps/ page, which now lives at /python/density-heatmaps/.

Docs-only change; no code is touched.

@camdecoster camdecoster self-assigned this Oct 13, 2026
@camdecoster

Copy link
Copy Markdown
Contributor

Thanks for the PR! Our team will review and follow up.

@camdecoster camdecoster left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for the PR! The casing changes aren't necessary because that's how the ids are set on the site. Could you please remove those? Additionally, a few of these files were recently updated so could you please merge main? Once you've done that, could you please verify that the remaining changes are fixing broken links?

The figures produced by Plotly Express can always be built from the ground up using graph objects, but this approach typically takes **5-100 lines of code rather than 1**.

Here is a simple example of how to produce the same figure object from the same data, once with Plotly Express and once without. Note that [Plotly Express functions](/python-api-reference/plotly.express.html) like [`px.bar()`](/python/bar-charts/) can accept a DataFrame as their first argument with column names passed to the `x` and `y` arguments, while [Graph Objects functions](/python-api-reference/plotly.graph_objects.html) like [`go.Bar()`](/python/bar-charts/#basic-bar-charts-with-plotlygraphobjects) require the data values to be passed directly to the `x` and `y` arguments as a tuple, list, NumPy array, or Pandas Series.
Here is a simple example of how to produce the same figure object from the same data, once with Plotly Express and once without. Note that [Plotly Express functions](/python-api-reference/plotly.express.html) like [`px.bar()`](/python/bar-charts/) can accept a DataFrame as their first argument with column names passed to the `x` and `y` arguments, while [Graph Objects functions](/python-api-reference/plotly.graph_objects.html) like [`go.Bar()`](/python/bar-charts/#Basic-Bar-Charts-with-plotly.graph_objects) require the data values to be passed directly to the `x` and `y` arguments as a tuple, list, NumPy array, or Pandas Series.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please revert this change. It's unnecessary.

@camdecoster camdecoster added the no-changelog A changelog entry is not required for this PR label Oct 16, 2026

This branch has not been deployed

No deployments
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

no-changelog A changelog entry is not required for this PR

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants