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

Make docs for root bloqs follow the same workflow as other bloqs #1583

Open
wants to merge 9 commits into
base: main
Choose a base branch
from

Conversation

NoureldinYosri
Copy link
Contributor

@NoureldinYosri NoureldinYosri commented Mar 5, 2025

based on our conversation from a few weeks ago @mpharrigan

@mpharrigan
Copy link
Collaborator

This pr adds a new file ecc_root.ipynb but doesn't remove ecc.ipynb. I guess the original organization had ecc.ipynb linked twice in the table of contents (TOC). What's the plan for handling this redundant information?

@NoureldinYosri
Copy link
Contributor Author

@mpharrigan how about renaming ecc.ipynb to ecc_arithmetic.ipynb? to highlight that that notebook contains the documentation of the bloqs used in doing ECC operations as opposed to the new ecc_root.ipynb which contains only the root bloq

@mpharrigan
Copy link
Collaborator

Sure, but there's still the same content copied in both places; namely qualtran.bloqs.cryptography.ecc.find_ecc_private_key._ECC_BLOQ_DOC,

@NoureldinYosri
Copy link
Contributor Author

yes, I left it for completeness ... or do you want to remove it?

@mpharrigan
Copy link
Collaborator

I'm not sure I have a strong preference either way. I was hoping you had some grand vision for how to organize these applications and subroutines :)

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.

2 participants