Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

DOC: Update KDA function documentation #92

Merged
merged 2 commits into from
Aug 5, 2024
Merged

Conversation

nawtrey
Copy link
Collaborator

@nawtrey nawtrey commented Aug 5, 2024

  • Update the text for most calculation functions to include the relevant equations and citations

  • Add references to diagrams.enumerate_partial_diagrams regarding
    Kirchhoff's Matrix-Tree theorem and the
    networkx implimentation of the same function

  • Misc minor changes to documentation format

  • Fixes issue Update CCW - CW explanations in functions #16

* Update the text for most calculation functions
to include the relevant equations and citations

* Add references to
`diagrams.enumerate_partial_diagrams` regarding
Kirchhoff's Matrix-Tree theorem and the
`networkx` implimentation of the same function

* Misc minor changes to documentation format
@nawtrey nawtrey added the documentation Improvements or additions to documentation label Aug 5, 2024
@nawtrey
Copy link
Collaborator Author

nawtrey commented Aug 5, 2024

I looked over the diff and everything looks good. Merging.

@nawtrey nawtrey merged commit 94e00c8 into master Aug 5, 2024
5 checks passed
@nawtrey nawtrey deleted the update_expression_docs branch August 5, 2024 04:30
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant