Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

cleaned up lib.log #2902

Merged
merged 2 commits into from
Aug 14, 2020
Merged

cleaned up lib.log #2902

merged 2 commits into from
Aug 14, 2020

Conversation

orbeckst
Copy link
Member

Fixes #2734

Changes made in this Pull Request:

  • docs now build with sphinx 2.4.4
  • removed unused code from lib.log (left over from ProgressMeter removal)
  • explicitly added docs to ProgressMeter
    • avoids sphinx failure due to wrong formatting in tqdm.auto.tqdm
    • add specific example for MDA
    • document our own verbose kwarg
    • improved markup
    • not documented: gui kwarg (discouraged in original docs)

PR Checklist

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

@pep8speaks
Copy link

pep8speaks commented Aug 11, 2020

Hello @orbeckst! Thanks for updating this PR. We checked the lines you've touched for PEP 8 issues, and found:

There are currently no PEP 8 issues detected in this Pull Request. Cheers! 🍻

Comment last updated at 2020-08-12 16:05:19 UTC

- fix #2734
  (docs now build with sphinx 2.3)
- removed unused code from lib.log (left over from ProgressMeter removal)
- explicitly added docs to ProgressMeter
  - avoids sphinx failure due to wrong formatting in tqdm.auto.tqdm
  - add specific example for MDA
  - document our own verbose kwarg
  - improved markup
  - not documented: gui kwarg (discouraged in original docs)
@codecov
Copy link

codecov bot commented Aug 12, 2020

Codecov Report

Merging #2902 into develop will increase coverage by 0.04%.
The diff coverage is 100.00%.

Impacted file tree graph

@@             Coverage Diff             @@
##           develop    #2902      +/-   ##
===========================================
+ Coverage    92.89%   92.94%   +0.04%     
===========================================
  Files          187      187              
  Lines        24587    24570      -17     
  Branches      3192     3189       -3     
===========================================
- Hits         22840    22836       -4     
+ Misses        1701     1688      -13     
  Partials        46       46              
Impacted Files Coverage Δ
package/MDAnalysis/lib/log.py 100.00% <100.00%> (+23.63%) ⬆️

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 a9e749c...6d774c3. Read the comment docs.

@orbeckst orbeckst requested review from cbouy and jbarnoud August 12, 2020 18:26
Copy link
Member

@cbouy cbouy left a comment

Choose a reason for hiding this comment

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

lgtm 👍

@orbeckst
Copy link
Member Author

@jbarnoud would you mind looking after this PR, please?

@richardjgowers richardjgowers merged commit 5e68617 into develop Aug 14, 2020
orbeckst added a commit that referenced this pull request Aug 16, 2020
- fix #2734
  (docs now build with sphinx 2.3)
- formally deprecated lib.log.echo() (CHANGELOG, @deprecate, and test)
- explicitly added docs to ProgressMeter
  - avoids sphinx failure due to wrong formatting in tqdm.auto.tqdm
  - add specific example for MDA
  - document our own verbose kwarg
  - improved markup
  - not documented: gui kwarg (discouraged in original docs)

(cherry picked from commit 5e68617)
PicoCentauri pushed a commit to PicoCentauri/mdanalysis that referenced this pull request Mar 30, 2021
- fix MDAnalysis#2734
  (docs now build with sphinx 2.3)
- removed unused code from lib.log (left over from ProgressMeter removal)
- explicitly added docs to ProgressMeter
  - avoids sphinx failure due to wrong formatting in tqdm.auto.tqdm
  - add specific example for MDA
  - document our own verbose kwarg
  - improved markup
  - not documented: gui kwarg (discouraged in original docs)
@IAlibay IAlibay deleted the cleanup-log branch May 29, 2022 12:56
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.

building docs fails with sphinx 2.0.1: unexpected unindents
6 participants