XanaduAI / strawberryfields

Strawberry Fields is a full-stack Python library for designing, simulating, and optimizing continuous variable (CV) quantum optical circuits.
https://strawberryfields.ai
Apache License 2.0
754 stars 191 forks source link

Refactor the configuration and CLI documentation pages #324

Closed josh146 closed 4 years ago

josh146 commented 4 years ago

Context:

In #319, the changes were requested for the pages configuration.rst, sf_configuration.rst, and sf_cli.rst. These are described below.

Description of the Change:

Benefits: suggested changes are incorporated

Possible Drawbacks: Changes requested for the hardware tutorial will be made in a new PR, once this has been merged in.

Related GitHub Issues: #319

codecov[bot] commented 4 years ago

Codecov Report

:exclamation: No coverage uploaded for pull request base (master@e557ba2). Click here to learn what that means. The diff coverage is n/a.

@@            Coverage Diff            @@
##             master     #324   +/-   ##
=========================================
  Coverage          ?   97.66%           
=========================================
  Files             ?       50           
  Lines             ?     6252           
  Branches          ?        0           
=========================================
  Hits              ?     6106           
  Misses            ?      146           
  Partials          ?        0
Impacted Files Coverage Δ
strawberryfields/cli/__init__.py 90.41% <ø> (ø)
strawberryfields/configuration.py 100% <ø> (ø)

Continue to review full report at Codecov.

Legend - Click here to learn more Δ = absolute <relative> (impact), ø = not affected, ? = missing data Powered by Codecov. Last update e557ba2...e46ad7f. Read the comment docs.