Skip to content

Fix: prevent custom edge_cmap from being overwritten in nx_draw_with_pos_and_attr (#93)#100

Open
Ashu-Rajput08 wants to merge 1 commit intomllam:mainfrom
Ashu-Rajput08:fix-edge-cmap-93
Open

Fix: prevent custom edge_cmap from being overwritten in nx_draw_with_pos_and_attr (#93)#100
Ashu-Rajput08 wants to merge 1 commit intomllam:mainfrom
Ashu-Rajput08:fix-edge-cmap-93

Conversation

@Ashu-Rajput08
Copy link
Copy Markdown

@Ashu-Rajput08 Ashu-Rajput08 commented Mar 13, 2026

Describe your changes

This PR fixes an issue in nx_draw_with_pos_and_attr where a user-provided edge_cmap could be unintentionally overwritten by the default colormap.

The existing implementation checked for the key "cmap" in kwargs before assigning a default edge colormap, while the value being set was "edge_cmap". Since "cmap" corresponds to the node colormap parameter, this mismatch caused the condition to evaluate to True even when a custom edge_cmap was already provided. As a result, the user-defined edge colormap could be silently replaced.

This change updates the condition to check for "edge_cmap" instead of "cmap", ensuring that the default edge colormap is only applied when the user has not explicitly provided one.

No additional dependencies are required for this change.

Issue Link

Closes #93

Type of change

  • 🐛 Bug fix (non-breaking change that fixes an issue)
  • ✨ New feature (non-breaking change that adds functionality)
  • 💥 Breaking change (fix or feature that would cause existing functionality to not work as expected)
  • 📖 Documentation (Addition or improvements to documentation)

Checklist before requesting a review

  • My branch is up-to-date with the target branch - if not update your fork with the changes from the target branch (use pull with --rebase option if possible).
  • I have performed a self-review of my code
  • For any new/modified functions/classes I have added docstrings that clearly describe its purpose, expected inputs and returned values
  • I have placed in-line comments to clarify the intent of any hard-to-understand passages of my code
  • I have updated the documentation to cover introduced code changes
  • I have added tests that prove my fix is effective or that my feature works
  • I have given the PR a name that clearly describes the change, written in imperative form (context).
  • I have requested a reviewer and an assignee (assignee is responsible for merging)

Checklist for reviewers

Each PR comes with its own improvements and flaws. The reviewer should check the following:

  • the code is readable
  • the code is well tested
  • the code is documented (including return types and parameters)
  • the code is easy to maintain

Author checklist after completed review

  • I have added a line to the CHANGELOG describing this change, in a section
    reflecting type of change (add section where missing):
    • added: when you have added new functionality
    • changed: when default behaviour of the code has been changed
    • fixes: when your contribution fixes a bug

Checklist for assignee

  • PR is up to date with the base branch
  • the tests pass
  • author has added an entry to the changelog (and designated the change as added, changed or fixed)
  • Once the PR is ready to be merged, squash commits and merge the PR.

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

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

#nx_draw_with_pos_and_attr silently overwrites custom edge_cmap due to wrong key check

1 participant