pygraphistry icon indicating copy to clipboard operation
pygraphistry copied to clipboard

Document that 'index' parameter in conditional.py is API, not a column name

Open lmeyerov opened this issue 2 months ago • 0 comments

Priority

Low-priority documentation

Background

PR #776 fixed identifier conflicts where GFQL operations failed when user graphs had columns named index. However, the string 'index' also appears in conditional.py - but this is NOT a column name conflict.

Current Behavior

In conditional_probs(), the index parameter refers to pandas index/column operations:

g.conditional_probs('col1', 'col2', how='index')

This is a parameter value, not a hardcoded column name that could conflict with user data.

Decision Rationale

  • The 'index' string in conditional.py is part of the user-facing API
  • It's a parameter option for how to perform operations, not a column name
  • No risk of conflict with user data columns named 'index'
  • No change needed

Test Reference

See test_conditional_probs_index_parameter in graphistry/tests/compute/test_identifier_conflicts.py

This test is intentionally skipped and documents that this is NOT a conflict to fix.

Locations

  • graphistry/compute/conditional.py:31,38,44,46,90,97

Documentation Task

Consider adding a clarifying comment in conditional.py to distinguish this from the column name conflicts fixed in PR #776.

lmeyerov avatar Oct 13 '25 00:10 lmeyerov