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

Move some notebooks to tutorials repository #1349

Merged
merged 5 commits into from
Jul 3, 2024
Merged

Conversation

MatteoRobbiati
Copy link
Contributor

I think the tutorials repository could be a nice place where to delve deeper into details of topics (e.g. in the case of the well documented DBI module) in form of notebooks.

I just opened a PR there: https://github.com/qiboteam/tutorials/pulls.
If someone else would prefer to take care of this feel, free to do it. Otherwise we can proceed like I suggested.

I would suggest to leave here at least the intro notebook and the readme file for completeness.

Checklist:

  • Reviewers confirm new code works as expected.
  • Tests are passing.
  • Coverage does not decrease.
  • Documentation is updated.

Copy link

codecov bot commented Jun 6, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 99.84%. Comparing base (ad50a20) to head (d882820).
Report is 69 commits behind head on master.

Additional details and impacted files
@@           Coverage Diff           @@
##           master    #1349   +/-   ##
=======================================
  Coverage   99.84%   99.84%           
=======================================
  Files          74       74           
  Lines       10806    10806           
=======================================
  Hits        10789    10789           
  Misses         17       17           
Flag Coverage Δ
unittests 99.84% <ø> (ø)

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@MatteoRobbiati MatteoRobbiati marked this pull request as ready for review June 25, 2024 08:59
Copy link
Contributor

@marekgluza marekgluza left a comment

Choose a reason for hiding this comment

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

@MatteoRobbiati I would leave it to @andrea-pasquale to decide - we were aiming to document the module using notebooks.

We could move them for now and then later pull them in but @andrea-pasquale moving them will not break the current docs?

Copy link
Contributor

@andrea-pasquale andrea-pasquale left a comment

Choose a reason for hiding this comment

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

Thanks @MatteoRobbiati, also the documentation needs to be updated propertly by removing the links to those notebooks.

@MatteoRobbiati MatteoRobbiati added this pull request to the merge queue Jul 3, 2024
Merged via the queue into master with commit 45727e0 Jul 3, 2024
27 checks passed
@scarrazza scarrazza deleted the dbi-notebooks branch August 3, 2024 07:32
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.

3 participants