Skip to content

add deprecation warning for mapbox traces and mapbox subplot - #7087

Merged
archmoj merged 8 commits into
masterfrom
deprecate-mapbox
Aug 29, 2024
Merged

add deprecation warning for mapbox traces and mapbox subplot#7087
archmoj merged 8 commits into
masterfrom
deprecate-mapbox

Conversation

@archmoj

Copy link
Copy Markdown
Contributor

With the introduction of scattermap, choroplethmap and densitymap as well as map subplots in #7060 this PR adds deprecation warnings to the description of scattermapbox, choroplethmaboxp and densitymapbox as well as mapbox subplots.

@plotly/plotly_js

@red-patiencered-patience left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

Okay for me if the style is consistent with other messages in this repo (not super familiar with its conventions)

@gvwilsongvwilson added feature something new P1 needed for current cycle labels Aug 13, 2024
@ndrezn

Copy link
Copy Markdown
Contributor

Previous deprecation warning example for reference: #5447

Comment threadsrc/traces/densitymapbox/index.js Outdated
Comment threadtest/plot-schema.json Outdated

@ndreznndrezn 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.

It doesn't look like these deprecations will appear in the console if these traces are used... is that correct? I would expect a console warning

@archmoj

Copy link
Copy Markdown
ContributorAuthor

It doesn't look like these deprecations will appear in the console if these traces are used... is that correct? I would expect a console warning

A warning is now added in the console when using a mapbox subplot.

@archmoj
archmoj requested a review from ndreznAugust 13, 2024 16:53
@archmoj

Copy link
Copy Markdown
ContributorAuthor

@emilykl Can I have your review on this PR please?

@emilykl

Copy link
Copy Markdown
Contributor

@archmoj@ndrezn I would suggest changing the wording of the first sentence to

{trace name} trace is deprecated and will be removed in the next major release.

to give a sense of urgency.

Comment threadsrc/traces/choroplethmapbox/index.js Outdated

@ndreznndrezn 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.

Once we have the link for the migration docs available, we should include that link directly in this deprecation warning.

@archmoj

Copy link
Copy Markdown
ContributorAuthor

@ndrezn Would you please take over this PR?

@ndrezn

Copy link
Copy Markdown
Contributor

@archmoj , I've added the link where the JS migration guide will live (it is not live yet). I believe that plot-schema.json is autogenerated, I haven't run the build locally before -- could you regenerate this and add to the PR? I think then this PR is good to merge! 🥳

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

Labels

featuresomething newP1needed for current cycle

Projects

None yet

Development

Successfully merging this pull request may close these issues.

5 participants

@archmoj@ndrezn@emilykl@red-patience@gvwilson