Update getting_started documentation 📘
#105
Conversation
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #105 +/- ##
=======================================
Coverage 96.19% 96.19%
=======================================
Files 36 36
Lines 2209 2209
=======================================
Hits 2125 2125
Misses 84 84 Continue to review full report in Codecov by Sentry.
|
soosub
changed the title
getting_started documentation 📘
|
|
I might move this one eventually
This is replaced by run_getting_started.py
| @@ -0,0 +1,71 @@ | |||
| """.. _getting-started-tutorial: | |||
There was a problem hiding this comment.
I don't know where this is relevant. Should this be included? I basically took it over from the tutorial .py files.
There was a problem hiding this comment.
This is just adding an explicit target label so that the document can be referenced using it. Is a nice to have but feel free to remove it if it finds no use.
There was a problem hiding this comment.
Okay, it's not used now but I will just leave it there as it might be useful in the future (and it doesn't hurt to keep it)
| "show_axes": True, | ||
| } | ||
|
|
||
| c = correct(RHG, decoder="MWPM", draw=True, drawing_opts=dw) |
There was a problem hiding this comment.
The generated figures are pretty small, and I think this is because the first matplotlib figures in a session are not according to the specified style (this also happens when using a jupy notebook). Maybe it's good to fix this at some point. What do you think?
There was a problem hiding this comment.
You can change the figure sizes by using plot_params from the viz module (here). For example
from flamingpy.utils.viz import plot_params
plot_params["figure.figsize"] = (16, 12)
This will increase (in fact duplicate) the size of all the figures.
There was a problem hiding this comment.
Alright, I will leave it like this for now. When addressing #54 we can also improve upon the presentation of the correct visualization on the readthedocs. The corresponding plots are on the small side.
|
@sduquemesa tp kindly review next. |
There was a problem hiding this comment.
Thanks @soosub for this addition! It does help to keep the documentation up-to-date 📆
I'm approving as this is already in good shape. I left a suggestion for how to increase figure sizes, please include it before merging.
| @@ -0,0 +1,71 @@ | |||
| """.. _getting-started-tutorial: | |||
There was a problem hiding this comment.
This is just adding an explicit target label so that the document can be referenced using it. Is a nice to have but feel free to remove it if it finds no use.
| "show_axes": True, | ||
| } | ||
|
|
||
| c = correct(RHG, decoder="MWPM", draw=True, drawing_opts=dw) |
There was a problem hiding this comment.
You can change the figure sizes by using plot_params from the viz module (here). For example
from flamingpy.utils.viz import plot_params
plot_params["figure.figsize"] = (16, 12)
This will increase (in fact duplicate) the size of all the figures.
Context for changes
The
getting_started.rstfile was not up-to-date. This PR fixes that and will prevent it from happening again. The latter is done by adding it to the list of files that are run when building documentation, just like the tutorials. Any errors should then be caught by the CI checks.getting_started.rstPerformance results justifying changes
Expected benefits and drawbacks
Expected benefits:
Possible drawbacks:
Related Github issues
getting_started.rstis outdated 👴🏼 #101Checklist and integration statements
black,docformatterandpylintconfigurations.README.mdas needed.CHANGELOG.mdfollowing the template. I recognize that the developers may revisitCHANGELOG.mdand the versioning, and create a Special Release including my changes.