You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
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.
- fix#3392
- writers are not required to process start, stop, step, which is what
all our code does anyway
- clarified that writer needs to ignore kwargs that they cannot process
- clarified that __init__ can delay actual I/O until Write
Fixes#3392
* change Coordinate Writer API
- writers are not required to process start, stop, step, which is what
all our code does anyway
- clarified that writer needs to ignore kwargs that they cannot process
- clarified that __init__ can delay actual I/O until Write
* doc cleanup in coordinates and converters
- fix links to Trajectory API
- link coordinates.ConverterBase to MDAnalysis.converters
- minor reST fixes
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
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
The text was updated successfully, but these errors were encountered: