docstring fixes to pybamm.plotting.quick_plot

[neilsengupta-elysia]

Description

Practise contributing to issue for Hackathon:

In the file pybamm.plotting.quick_plot.py, added "optional" keyword to "step" argument in dynamic_plot function. Removed round brackets around optional keywords in the arguments "number_of_images", "duration", "output_filename" in create_gif function.

Related #3392 - Improve documentation

Type of change

Documentation Update

[codecov]

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 99.58%. Comparing base (c204bdd) to head (dc05fea).
Report is 2 commits behind head on develop.

Additional details and impacted files

@@           Coverage Diff            @@
##           develop    #3970   +/-   ##
========================================
  Coverage    99.58%   99.58%           
========================================
  Files          257      257           
  Lines        21251    21251           
========================================
  Hits         21163    21163           
  Misses          88       88           

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

[brosaplanella]

Just a small comment, but looks good overall!

[kratman]

While the syntax used in your issue description

Fixes # Issue 3392 - Improve documentation (partial fix)

will not work because it is incorrectly formatted, you should not mark a partial fix as with the fixes tag. When used correctly the fixes keyword causes the issue to be closed. This would me that this 10 line change would close a much larger ticket.

Usually you can do

Related #3392

to tag the issue without closing it

[neilsengupta-elysia]

Fixed PR description to remove "fixes" keyword

[kratman]

@neilsengupta-elysia I updated your PR description. Having Related # issue 3392 does not work, it needs to be Related #3392. If there are any spaces between # and the number it will not link properly