Skip to content

Commit

Permalink
Fix: groups.py doctest fixes (#4374)
Browse files Browse the repository at this point in the history
* part of #3925 (doc test mega issue)
* Fixed all failing doctests in groups.py using sphinx directives
   NOTE: These tests will not pass using `pytest -v --disable-pytest-warnings --doctest-modules` 
   since I used sphinx directives to allow for concise example code. This can be changed but the 
   documentation will become more verbose.
* Updated CHANGELOG
  • Loading branch information
ljwoods2 authored Mar 29, 2024
1 parent dfcd06f commit 0ff14c7
Show file tree
Hide file tree
Showing 2 changed files with 384 additions and 186 deletions.
1 change: 1 addition & 0 deletions package/CHANGELOG
Original file line number Diff line number Diff line change
Expand Up @@ -32,6 +32,7 @@ Fixes
`DistanceMatrix.run(frames=...)` (PR #4433)
* Fix doctest errors of lib/picklable_file_io.py (Issue #3925, PR #4371)
* Fix deploy action to use the correct version of the pypi upload action.
* Fix groups.py doctests using sphinx directives (Issue #3925, PR #4374)

Enhancements
* Added a tqdm progress bar for `MDAnalysis.analysis.pca.PCA.transform()`
Expand Down
Loading

0 comments on commit 0ff14c7

Please sign in to comment.