Skip to content

Add deprecation of passing portrayal arguments to draw() methods to migration guide#3202

Merged
EwoutH merged 2 commits intomesa:mainfrom
EwoutH:migration_guide_draw_methods
Jan 25, 2026
Merged

Add deprecation of passing portrayal arguments to draw() methods to migration guide#3202
EwoutH merged 2 commits intomesa:mainfrom
EwoutH:migration_guide_draw_methods

Conversation

@EwoutH
Copy link
Copy Markdown
Member

@EwoutH EwoutH commented Jan 24, 2026

Summary

Adds migration guide documentation for the deprecation of passing portrayal arguments directly to draw_agents() and draw_propertylayer() methods, introduced in PR #3144.

Migration guide entry

The new section shows users how to update their code:

# Old
renderer.draw_agents(agent_portrayal=agent_portrayal)
renderer.draw_propertylayer(propertylayer_portrayal)

# New
renderer.setup_agents(agent_portrayal).draw_agents()
renderer.setup_propertylayer(propertylayer_portrayal).draw_propertylayer()

Fixes a violation in the deprecation policy, should have happened in #3144 at the latest when the PendingDeprecationWarning was updated to FutureWarning.

@EwoutH EwoutH changed the title asdf Add deprecation of passing portrayal arguments to draw() methods to migration guide Jan 24, 2026
@EwoutH EwoutH added the docs Release notes label label Jan 24, 2026
@EwoutH EwoutH requested a review from Sahil-Chhoker January 24, 2026 16:55
@EwoutH EwoutH marked this pull request as ready for review January 24, 2026 16:55
@github-actions

This comment was marked as off-topic.

Copy link
Copy Markdown
Collaborator

@Sahil-Chhoker Sahil-Chhoker left a comment

Choose a reason for hiding this comment

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

LGTM!

@EwoutH EwoutH merged commit 2f58b3d into mesa:main Jan 25, 2026
13 of 14 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

docs Release notes label

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants