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

Add Qibo conversions to documentation #2214

Merged
merged 5 commits into from
Mar 4, 2024
Merged

Conversation

nathanshammah
Copy link
Member

@nathanshammah nathanshammah commented Feb 29, 2024

Add Qibo conversions to documentation in API-Doc and to Readme.

Add Qibo conversions to documentation in API-Doc
Copy link

codecov bot commented Feb 29, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 98.28%. Comparing base (f8f1e8c) to head (99f1e7b).

Additional details and impacted files
@@           Coverage Diff           @@
##           master    #2214   +/-   ##
=======================================
  Coverage   98.28%   98.28%           
=======================================
  Files          90       90           
  Lines        4259     4259           
=======================================
  Hits         4186     4186           
  Misses         73       73           

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

@nathanshammah
Copy link
Member Author

Looks like Qibo is cut away in the RTD rendering of the Readme page. Trying to shrink all the logo sizes in the table to see if it works.

README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
Copy link
Contributor

@Misty-W Misty-W left a comment

Choose a reason for hiding this comment

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

Nice resizing of the logos, LGTM!

Docs build failure is unrelated (broken links). The "broken" links still work in Chrome, so I'm re-running the docs build to see if it was due to a temporary outage. Docs build ok now.

Comment on lines 368 to 373
#### Qibo Conversions

```{eval-rst}
.. automodule:: mitiq.interface.mitiq_qibo.conversions
:members:
```
Copy link
Member

Choose a reason for hiding this comment

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

Question: There are a bunch of functions in this module that maybe don't need to go into the API-doc. E.g. all the ..._decomp functions. Should we just have the to_qibo and from_qibo functions?

docs/source/apidoc.md Outdated Show resolved Hide resolved
@nathanshammah
Copy link
Member Author

Thanks @natestemen, I've addressed the issue, it looks better now (preview).

Copy link
Member

@natestemen natestemen left a comment

Choose a reason for hiding this comment

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

:shipit:

@natestemen natestemen merged commit 6a30f16 into master Mar 4, 2024
18 checks passed
@natestemen natestemen deleted the nathanshammah-patch-2 branch March 4, 2024 20:37
@natestemen
Copy link
Member

BTW @nathanshammah please try to use branch name that's descriptive of what the branch contains. A few ideas about how one can do this are available here.

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.

None yet

3 participants