Skip to content

Conversation

@NoureldinYosri
Copy link
Contributor

@NoureldinYosri NoureldinYosri commented Jan 29, 2025

  • factoring/ contains code for both ECC and RSA so a better name for it is cryptography
  • created a section in the docs for Root Bloqs with the first one being FindECCPrivateKey which already exists

@NoureldinYosri NoureldinYosri marked this pull request as ready for review January 29, 2025 21:02
Comment on lines +71 to +74
# --------------------------------------------------------------------------
# ----- Root Bloqs -----------------------------------------------------
# --------------------------------------------------------------------------
ROOT_BLOQS = ['cryptography/ecc/ecc.ipynb']
Copy link
Collaborator

Choose a reason for hiding this comment

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

why can't these be bloq notebooks like the rest of the bloq notebooks

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I don't understand the comment. this is an existing bloq notebook and I'm just putting a second link to it in the new section

Copy link
Collaborator

Choose a reason for hiding this comment

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

The idiomatic way to include bloq documentation in the TOC is by adding a NotebookSpecV2 to the correct section List[NotebookSpecV2]. Each section list is added to NB_BY_SECTION: Dict[str, List[...]]

Copy link
Contributor Author

Choose a reason for hiding this comment

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

yes I get that and that notebook is already there

NotebookSpecV2(
title='Elliptic Curve Cryptography',
module=qualtran.bloqs.cryptography.ecc,
bloq_specs=[
qualtran.bloqs.cryptography.ecc.find_ecc_private_key._ECC_BLOQ_DOC,
qualtran.bloqs.cryptography.ecc.ec_phase_estimate_r._EC_PE_BLOQ_DOC,
qualtran.bloqs.cryptography.ecc.ec_add_r._ECC_ADD_R_BLOQ_DOC,
qualtran.bloqs.cryptography.ecc.ec_add_r._EC_WINDOW_ADD_BLOQ_DOC,
],

image


what I'm doing here is creating a new section
image

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