Skip to content

Fix writer apidocs#3393

Merged
IAlibay merged 2 commits intodevelopfrom
fix-writer-apidocs
Aug 20, 2021
Merged

Fix writer apidocs#3393
IAlibay merged 2 commits intodevelopfrom
fix-writer-apidocs

Conversation

@orbeckst
Copy link
Member

Fixes #3392

Changes made in this Pull Request:

  • minimal adjustments to the Trajectory API docs for Writers so that they reflect our practice
  • small doc fixes in coordinates and converters
  • CHANGELOG: note API change in Changes

PR Checklist

  • n/a Tests?
  • Docs?
  • CHANGELOG updated?
  • Issue raised/referenced?

- 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
- fix links to Trajectory API
- link coordinates.ConverterBase to MDAnalysis.converters
- minor reST fixes
@orbeckst orbeckst added this to the 2.0 milestone Aug 19, 2021
@codecov
Copy link

codecov bot commented Aug 19, 2021

Codecov Report

Merging #3393 (80698c1) into develop (a40c23b) will not change coverage.
The diff coverage is n/a.

Impacted file tree graph

@@           Coverage Diff            @@
##           develop    #3393   +/-   ##
========================================
  Coverage    93.69%   93.69%           
========================================
  Files          177      177           
  Lines        22959    22959           
  Branches      3234     3234           
========================================
  Hits         21511    21511           
  Misses        1397     1397           
  Partials        51       51           
Impacted Files Coverage Δ
package/MDAnalysis/coordinates/__init__.py 100.00% <ø> (ø)
package/MDAnalysis/coordinates/base.py 95.35% <ø> (ø)

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 a40c23b...80698c1. Read the comment docs.

Copy link
Member

@IAlibay IAlibay left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

lgtm, thanks @orbeckst !

@orbeckst
Copy link
Member Author

thanks, please merge whenever @IAlibay

@IAlibay IAlibay merged commit 00c4c3c into develop Aug 20, 2021
@IAlibay IAlibay deleted the fix-writer-apidocs branch August 20, 2021 19:55
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

update the Trajectory API docs: Writers

2 participants