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

Improving documentation of models.encodings.entangling_layer #1273

Merged
merged 11 commits into from
Mar 22, 2024

Conversation

renatomello
Copy link
Contributor

@renatomello renatomello commented Mar 18, 2024

Checklist:

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

@renatomello renatomello added the documentation Improvements or additions to documentation label Mar 18, 2024
@renatomello renatomello added this to the Qibo 0.2.7 milestone Mar 18, 2024
@renatomello renatomello self-assigned this Mar 18, 2024
Copy link

codecov bot commented Mar 18, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 99.85%. Comparing base (d1eecbb) to head (65aee42).

Additional details and impacted files
@@           Coverage Diff           @@
##           master    #1273   +/-   ##
=======================================
  Coverage   99.85%   99.85%           
=======================================
  Files          73       73           
  Lines       10690    10690           
=======================================
  Hits        10674    10674           
  Misses         16       16           
Flag Coverage Δ
unittests 99.85% <ø> (ø)

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.

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 @renatomello!

I think it would be better to standardize a bit more the images in the section. To do this, we should keep the width in the usual range of 400px-800px, and regulate the height. For helping in this, I opened #1278, where the scale tag is removed and the images widths and heights are rescaled to fit the aforementioned range.

The #1278 is pointing here, thus I would suggest to check that one and then proceed with this PR.

A couple of suggestions follow.

doc/source/api-reference/qibo.rst Outdated Show resolved Hide resolved
doc/source/api-reference/qibo.rst Outdated Show resolved Hide resolved
renatomello and others added 3 commits March 19, 2024 10:32
Co-authored-by: Matteo Robbiati <62071516+MatteoRobbiati@users.noreply.github.com>
Co-authored-by: Matteo Robbiati <62071516+MatteoRobbiati@users.noreply.github.com>
Standardize images in encoding documentation
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 Mar 22, 2024
Merged via the queue into master with commit 8fd5657 Mar 22, 2024
21 checks passed
@scarrazza scarrazza deleted the entangling_layer_doc branch June 25, 2024 09:56
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