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: Add algorithm references to function docstrings #65

Closed
nawtrey opened this issue Mar 23, 2022 · 2 comments
Closed

DOC: Add algorithm references to function docstrings #65

nawtrey opened this issue Mar 23, 2022 · 2 comments
Labels
documentation Improvements or additions to documentation wontfix This will not be worked on

Comments

@nawtrey
Copy link
Collaborator

nawtrey commented Mar 23, 2022

When the pseudocode algorithms are finished for the partial, directional, and flux diagram generation functions it would be good to add references to these in the corresponding docstrings.

@nawtrey nawtrey added the documentation Improvements or additions to documentation label Mar 23, 2022
@nawtrey
Copy link
Collaborator Author

nawtrey commented Aug 5, 2024

This is probably best handled once the KDA paper is published so I can add the actual citation to the documentation.

@nawtrey nawtrey added the wontfix This will not be worked on label Aug 18, 2024
@nawtrey
Copy link
Collaborator Author

nawtrey commented Aug 18, 2024

With 61a1fcb merged I think this issue is on the path to being closed. I've already spent some time working on changes for the partial diagrams algorithm, and the flux diagrams algo is likely to change soon as well, so I don't think adding these labels to the documentation will be of any real use.

@nawtrey nawtrey closed this as completed Aug 18, 2024
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 wontfix This will not be worked on
Projects
None yet
Development

No branches or pull requests

1 participant