-
Notifications
You must be signed in to change notification settings - Fork 603
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 documentation for supported functionality #2540
Conversation
Codecov Report
@@ Coverage Diff @@
## master #2540 +/- ##
=======================================
Coverage 99.58% 99.58%
=======================================
Files 243 243
Lines 19595 19595
=======================================
+ Hits 19513 19514 +1
+ Misses 82 81 -1
Continue to review full report at Codecov.
|
Co-authored-by: antalszava <antalszava@gmail.com>
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Hi @eddddddy, this is a huge effort and will bring us forward a lot 💪 🎉
Not only does it provide info to users, but we also have a more systematic check-in place for cases that can go a long way for our testing practices.
Left some suggestions. No real blockers, rather polishing. One general thought is that if a functionality doesn't work as we'd like and there's an issue open (or will be opened), then linking the issue number/link in a comment can also help with a TODO marker. Also, in the issue itself, marking the parts of this addition can help because once the issue is resolved, those parts would also have to be updated.
Co-authored-by: antalszava <antalszava@gmail.com>
Co-authored-by: antalszava <antalszava@gmail.com>
Co-authored-by: antalszava <antalszava@gmail.com>
Co-authored-by: antalszava <antalszava@gmail.com>
Co-authored-by: antalszava <antalszava@gmail.com>
Co-authored-by: antalszava <antalszava@gmail.com>
Co-authored-by: antalszava <antalszava@gmail.com>
Co-authored-by: antalszava <antalszava@gmail.com>
Co-authored-by: antalszava <antalszava@gmail.com>
Co-authored-by: antalszava <antalszava@gmail.com>
Co-authored-by: antalszava <antalszava@gmail.com>
Co-authored-by: antalszava <antalszava@gmail.com>
Co-authored-by: antalszava <antalszava@gmail.com>
Co-authored-by: antalszava <antalszava@gmail.com>
Co-authored-by: antalszava <antalszava@gmail.com>
Co-authored-by: antalszava <antalszava@gmail.com>
[sc-19547] |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Looks great @eddddddy! 🏆 Once the comments are addressed, this is ready to be merged. The ones marked as minor/as an idea are up for consideration, no definite need to change the behaviour there.
Co-authored-by: antalszava <antalszava@gmail.com>
Co-authored-by: antalszava <antalszava@gmail.com>
Co-authored-by: antalszava <antalszava@gmail.com>
Context:
In general, the amount of configurations for QNodes is quite large, and due to the supported 5 interfaces, it is quite hard to estimate a priori which scenarios are supported, which can not be supported for mathematical/programmatical reasons and which are simply not yet supported because they haven't been implemented.
Description of the Change:
Provides an overview in the documentation that informs users about the supported scenarios, and explains which scenarios are conceptually unsupportable and why.
Benefits:
Better documentation and faster lookups.
Possible Drawbacks:
Related GitHub Issues:
Closes #1997