update the Trajectory API docs: Writers

[orbeckst]

Expected behavior

API docs https://docs.mdanalysis.org/2.0.0-dev0/documentation_pages/coordinates/init.html#trajectory-api and code (namely coordinates.base.WriterBase etc) agree

Actual behavior

API docs require start, stop, step, dt but the writers, starting with

mdanalysis/package/MDAnalysis/coordinates/base.py

Line 2204 in 55ffd25

class WriterBase(IOBase, metaclass=_Writermeta):

and (#3294 (comment)) and other main writers (DCD, XDR, LAMMPS), don't use start/step/delta (or even has it as a parameter for init).

The closest we have is step and dt for the DCDWriter, although worth nothing that it's not immediately clear that step actually does anything.

Suggested resolution

It's possible I'm missing something, but since it doesn't look like writers don't meet the API's requirements to have start, stop, step, dt (either as parameters to init or as class attributes) we just clean up the API docs to match our code.

Background

See eg #3294 (comment)

Current version of MDAnalysis

• Which version are you using? 2.0.0-dev