mitiq icon indicating copy to clipboard operation
mitiq copied to clipboard

REM: Write documentation

Open amirebrahimi opened this issue 2 years ago • 2 comments

Per #815, write the documentation sections for the RFC approved in #1387.

Requirements: Write documentation for the following sections:

  1. How do I use REM?
  2. When should I use REM?
  3. What additional options are available when using REM?1. What happens when I use REM?
  4. What is the theory behind REM?

These are the corresponding sub-issues:

  • [ ] #1451
  • [ ] #1452
  • [ ] #1453
  • [ ] #1454
  • [ ] #1455

Considerations:

  • A rough outline for the documentation is here

amirebrahimi avatar Aug 21 '22 23:08 amirebrahimi

Thanks @amirebrahimi! This looks great. Possibly this could be a "super-issue" with sub-issues for each of the five sections, see for example https://github.com/unitaryfund/mitiq/issues/1210.

nathanshammah avatar Aug 22 '22 08:08 nathanshammah

Thanks @amirebrahimi! This looks great. Possibly this could be a "super-issue" with sub-issues for each of the five sections, see for example #1210.

Thanks. I've added the sub-issues.

amirebrahimi avatar Aug 22 '22 17:08 amirebrahimi

@Misty-W - could you please assign this super ticket and sub-issues to me?

amirebrahimi avatar Nov 22 '22 19:11 amirebrahimi

@Misty-W - could you please assign this super ticket and sub-issues to me?

Done!

Misty-W avatar Nov 22 '22 19:11 Misty-W

All sub-tasks complete, so closing this ticket.

amirebrahimi avatar Feb 24 '23 20:02 amirebrahimi

Thanks @amirebrahimi for all the code and docs support on REM!

andreamari avatar Feb 28 '23 10:02 andreamari