Skip to content

Add info on generating package info locally#4838

Open
abbycross wants to merge 1 commit intomainfrom
ajc/update-readme
Open

Add info on generating package info locally#4838
abbycross wants to merge 1 commit intomainfrom
ajc/update-readme

Conversation

@abbycross
Copy link
Collaborator

No description provided.

Copy link
Collaborator

@Eric-Arellano Eric-Arellano left a comment

Choose a reason for hiding this comment

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

Thanks for working on this!


Add a new markdown cell under your title with a `version-info` tag.
When you execute the notebook (see the next section), the script will populate
When you execute the notebook locally with either When you execute the notebook locally with either `tox -- docs/guides/circuit-transpilation-settings.ipynb --test-strategy=hardware --write` or `tox -- docs/guides/circuit-transpilation-settings.ipynb --test-strategy=hardware --write --patch '{patch="qiskit-ibm-runtime"}'`, the script will populate
Copy link
Collaborator

Choose a reason for hiding this comment

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

Something got messed up here with the grmmar

When you execute the notebook locally with either When you execute the notebook locally with either `tox -- docs/guides/circuit-transpilation-settings.ipynb --test-strategy=hardware --write` or `tox -- docs/guides/circuit-transpilation-settings.ipynb --test-strategy=hardware --write --patch '{patch="qiskit-ibm-runtime"}'`, the script will populate
this cell with the package versions so users can reproduce the results.

It will also update during the cron jobs.
Copy link
Collaborator

Choose a reason for hiding this comment

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

It was ambiguous

Suggested change
It will also update during the cron jobs.
The package versions will also update during the cron jobs.

tox -- <path/to/notebook.ipynb> <path/to/another-notebook.ipynb>
```
- To write the execution results to the file, pass the `--write` argument.
- To write the execution results to the file, pass the `--write` argument. (Note this generates the package version info cell mentioned in [this section](#add-package-version-information).)
Copy link
Collaborator

Choose a reason for hiding this comment

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

I think this might be noisy? Unless you're specifically trying to update the versions, this is kind of noisy and you'd see in the Git diff already that it changed.

If you are trying to update the versions, hopefully you would find the section in the README above about that

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

Status: No status

Development

Successfully merging this pull request may close these issues.

2 participants