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

Update outdated docstrings #1512

Merged
merged 28 commits into from
Nov 13, 2024
Merged

Update outdated docstrings #1512

merged 28 commits into from
Nov 13, 2024

Conversation

renatomello
Copy link
Contributor

@renatomello renatomello commented Oct 31, 2024

A lot of the older docstrings do not match the new functionalities added on qibo in the last $2$ or so years. This PR updates them.

One of the main goals is to discourage people who first interact with the docs from getting in the habit of using unnecessarily short variable names, which leads to issues when the same people then start contributing code in PRs.

Checklist:

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

@renatomello renatomello self-assigned this Oct 31, 2024
@renatomello renatomello added the documentation Improvements or additions to documentation label Oct 31, 2024
@renatomello renatomello marked this pull request as ready for review November 1, 2024 05:20
Copy link

codecov bot commented Nov 1, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 99.72%. Comparing base (a8e7edd) to head (3110f99).
Report is 31 commits behind head on master.

Additional details and impacted files
@@            Coverage Diff             @@
##           master    #1512      +/-   ##
==========================================
- Coverage   99.72%   99.72%   -0.01%     
==========================================
  Files          80       80              
  Lines       11784    11783       -1     
==========================================
- Hits        11752    11751       -1     
  Misses         32       32              
Flag Coverage Δ
unittests 99.72% <100.00%> (-0.01%) ⬇️

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 added this to the Qibo 0.2.14 milestone Nov 6, 2024
Copy link
Contributor

@MatteoRobbiati MatteoRobbiati left a comment

Choose a reason for hiding this comment

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

Thanks! Some minor suggestions follow.

examples/qclustering/distance_calc.py Outdated Show resolved Hide resolved
examples/qclustering/distance_calc.py Outdated Show resolved Hide resolved
src/qibo/gates/abstract.py Show resolved Hide resolved
src/qibo/gates/measurements.py Outdated Show resolved Hide resolved
src/qibo/models/qcnn.py Outdated Show resolved Hide resolved
src/qibo/noise_model.py Outdated Show resolved Hide resolved
Co-authored-by: Matteo Robbiati <[email protected]>
Copy link
Contributor

@MatteoRobbiati MatteoRobbiati 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 MatteoRobbiati added this pull request to the merge queue Nov 13, 2024
Merged via the queue into master with commit 9474eaa Nov 13, 2024
27 checks passed
@renatomello renatomello deleted the docs branch November 14, 2024 05:51
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
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants