Skip to content

Conversation

@GuySten
Copy link
Contributor

@GuySten GuySten commented Jan 1, 2026

Description

Currently Hexagonal lattice orientation is inverted with respect to what is documented.
This PR flip it.

Fixes #3537

Checklist

  • I have performed a self-review of my own code
  • I have run clang-format (version 15) on any C++ source files (if applicable)
  • I have followed the style guidelines for Python source files (if applicable)
  • I have made corresponding changes to the documentation (if applicable)
  • I have added tests that prove my fix is effective or that my feature works (if applicable)

@GuySten GuySten marked this pull request as ready for review January 1, 2026 23:57
@GuySten GuySten requested a review from ebknudsen January 4, 2026 18:01
Copy link
Contributor

@paulromano paulromano left a comment

Choose a reason for hiding this comment

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

I'm not in favor of changing behavior that will break backward compatibility. Looking at the original PR that added this (#1216), it was the intent that the y orientation corresponds to what is currently shown in #3537. So, I think a prudent course of action is to update the documentation of the orientation (which currently sounds like gibberish to me) to make clear what the 'x' and 'y' mean. I'll submit a PR today with a doc fix.

@paulromano paulromano closed this Jan 6, 2026
@GuySten GuySten deleted the fix-hex-lat branch January 6, 2026 15:59
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

HexLattice docs does not agree with functionality

2 participants