Skip to content

Comments

518 distanceblockpy calculate block to block distance add reference equation to the documentation#519

Merged
SimonMolinsky merged 2 commits intodevfrom
518-distanceblockpy---_calculate_block_to_block_distance---add-reference-equation-to-the-documentation
Feb 22, 2026
Merged

518 distanceblockpy calculate block to block distance add reference equation to the documentation#519
SimonMolinsky merged 2 commits intodevfrom
518-distanceblockpy---_calculate_block_to_block_distance---add-reference-equation-to-the-documentation

Conversation

@SimonMolinsky
Copy link
Member

Missing equation in block-to-block distance calculation

Package version (main branch)

version: 1.2.1

Description

Equation placed in docstring of the function.

Problem

It makes devs life easier and users can validate the code.

Solution

Write an equation and compile docs.

Affected modules

  • distance

Unit tests

  • n/a

Package check

  • All tests passed
  • Documentation updated
  • [-] All tutorials are working properly

(Optional) Additional info

Is feature related to literature? Does change require new dependencies? Any other information...

@SimonMolinsky SimonMolinsky merged commit 4a2ba1f into dev Feb 22, 2026
12 checks passed
@SimonMolinsky SimonMolinsky deleted the 518-distanceblockpy---_calculate_block_to_block_distance---add-reference-equation-to-the-documentation branch February 22, 2026 10:44
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.

1 participant