Add documentation for particle plots [out3]

[awirb]

Read the doc activated. Link here:
https://docs.avaframe.org/en/adddocuparticles/

[pep8speaks]

Hello @awirb! Thanks for updating this PR.

• In the file avaframe/out3Plot/outAIMEC.py:

Line 1395:35: W292 no newline at end of file
Line 1364:1: E303 too many blank lines (3)
Line 1318:121: E501 line too long (133 > 120 characters)
Line 1318:23: E127 continuation line over-indented for visual indent
Line 1317:38: E225 missing whitespace around operator
Line 1307:20: E251 unexpected spaces around keyword / parameter equals
Line 1255:45: E222 multiple spaces after operator
Line 1201:50: E712 comparison to False should be 'if cond is False:' or 'if not cond:'
Line 1012:121: E501 line too long (121 > 120 characters)
Line 1012:41: E225 missing whitespace around operator
Line 989:17: E265 block comment should start with '# '
Line 989:17: E116 unexpected indentation (comment)
Line 926:13: E117 over-indented
Line 826:67: E127 continuation line over-indented for visual indent
Line 687:5: E265 block comment should start with '# '
Line 672:74: E225 missing whitespace around operator
Line 666:121: E501 line too long (121 > 120 characters)
Line 645:121: E501 line too long (121 > 120 characters)
Line 643:9: E265 block comment should start with '# '
Line 636:121: E501 line too long (124 > 120 characters)
Line 621:121: E501 line too long (123 > 120 characters)
Line 613:121: E501 line too long (138 > 120 characters)
Line 321:23: E127 continuation line over-indented for visual indent
Line 313:121: E501 line too long (124 > 120 characters)
Line 301:17: E265 block comment should start with '# '
Line 301:17: E116 unexpected indentation (comment)

• In the file avaframe/out3Plot/outParticlesAnalysis.py:

Line 109:50: E241 multiple spaces after ','
Line 107:50: E241 multiple spaces after ','

• In the file avaframe/out3Plot/plotUtils.py:

Line 520:15: E711 comparison to None should be 'if cond is not None:'

• In the file avaframe/runScripts/runParticleAnalysisPlots.py:

Line 133:121: E501 line too long (138 > 120 characters)
Line 95:1: E265 block comment should start with '# '
Line 94:121: E501 line too long (128 > 120 characters)
Line 41:1: E266 too many leading '#' for block comment
Line 31:1: E266 too many leading '#' for block comment

Comment last updated at 2023-10-11 08:47:47 UTC

[codecov]

Codecov Report

Attention: 25 lines in your changes are missing coverage. Please review.

Comparison is base (711b23c) 73.73% compared to head (24a1728) 73.74%.
Report is 1 commits behind head on master.

Additional details and impacted files

@@            Coverage Diff             @@
##           master     #922      +/-   ##
==========================================
+ Coverage   73.73%   73.74%   +0.01%     
==========================================
  Files          63       63              
  Lines       14579    14582       +3     
==========================================
+ Hits        10750    10754       +4     
+ Misses       3829     3828       -1     

Files	Coverage Δ
avaframe/ana3AIMEC/ana3AIMEC.py	76.75% <100.00%> (+0.12%)	⬆️
avaframe/out3Plot/plotUtils.py	93.17% <66.66%> (ø)
avaframe/out3Plot/outAIMEC.py	80.00% <72.22%> (+0.19%)	⬆️
avaframe/out3Plot/outParticlesAnalysis.py	37.70% <32.14%> (ø)

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

[qlty-cloud-legacy]

Code Climate has analyzed commit 24a1728 and detected 0 issues on this pull request.

The test coverage on the diff in this pull request is 47.9% (50% is the threshold).

This pull request will bring the total coverage in the repository to 73.7% (0.0% change).

View more on Code Climate.