Added examples in documentation to mass_density and Hall_parame… #709

diego7319 · 2019-10-22T05:06:31Z

-Closes #708.
-Added examples to documentation to mass_density and Hall_parameter functions that were missing.
-Changed a ValueError in mass_density with a clearer message :
From : You must pass a particle (not None) to calculate the mass density!
to: If passing a number density, you must pass a particle (not None) to calculate the mass density!

codecov · 2019-10-22T05:14:06Z

Codecov Report

Merging #709 into master will not change coverage.
The diff coverage is 100%.

@@           Coverage Diff           @@
##           master     #709   +/-   ##
=======================================
  Coverage   95.02%   95.02%           
=======================================
  Files          57       57           
  Lines        4722     4722           
=======================================
  Hits         4487     4487           
  Misses        235      235

Impacted Files	Coverage Δ
plasmapy/formulary/parameters.py	`98.9% <100%> (ø)`	⬆️

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 0876fb3...a11bbcf. Read the comment docs.

StanczakDominik · 2019-10-22T05:15:11Z

Looks like this PR includes a bunch of commits from the asv benchmark PR; would you like me to clean it up for you? :)

plasmapy/formulary/parameters.py

diego7319 · 2019-10-22T05:19:11Z

Looks like this PR includes a bunch of commits from the asv benchmark PR; would you like me to clean it up for you? :)

yes please , I dont know why that happened

plasmapy/formulary/parameters.py

changelog file

StanczakDominik · 2019-10-22T05:29:15Z

That should do it! My best guess is that you stayed on your asv-benchmark branch before creating this new new_examples_doc one instead of switching to master, updating the current repo state via git pull, and then branching out of master. That's the best way to create short single feature branches, as far as I know.

What you did is, by the way, a completely viable strategy when you're making a huge change that you'd prefer to break up into a few parts for easier, "staged" review. 😄

StanczakDominik · 2019-10-22T05:31:56Z

plasmapy/formulary/parameters.py

+    >>> Hall_parameter(1e10 * u.m**-3, 2.8e3 * u.eV, 2.3 * u.T, 'He-4 +1')
+    <Quantity 7.26446755e+16>
+    >>> Hall_parameter(1e10 * u.m**-3, 5.8e3 * u.eV, 2.3 * u.T, 'He-4 +1')
+    <Quantity 3.25995498e+17>


Tests seem to output the following value here:

Suggested change

<Quantity 3.25995498e+17>

<Quantity 2.11158408e+17>

I may have messed the particle up while adding whitespace, didn't you have a proton or some such here before?

Anyway, it should be fine to keep it as it is and just modify the value :)

I just pushed the change

diego7319 · 2019-10-22T05:32:55Z

I just deleted that branch, those commits are no longer showing up, is it because that branch is gone or you did something?

StanczakDominik · 2019-10-22T05:37:16Z

I just deleted that branch, those commits are no longer showing up, is it because that branch is gone or you did something?

I force-pushed to your branch due to AWESOME MAINTAINER POWERS, it shows up here if you scroll up:

@StanczakDominik force-pushed the diego7319:new_examples_doc branch from 4db44d9 to 8ed818f 9 minutes ago

I forgot to mention but you should now probably git fetch, then git reset origin/new_examples_doc to get the branch state from your github version of this branch.

StanczakDominik · 2019-10-22T05:37:45Z

Or keep it deleted, since we're mostly done here!

StanczakDominik · 2019-10-22T05:40:17Z

What I did locally, if you're interested, is:

git rebase -i master to drop the previous PR's commits and squash the changes into a single commit, then
git reset --patch master; git commit --amend to clean up some unnecessary white space changes from another commit which you accidentally included.

Nothing like some git magic to start your day :D

diego7319 · 2019-10-22T05:42:24Z

I'm having some errors during the test process (python setup.py test),
TypeError: calling <function particle_input at 0x000001CC0CCBE678> returned <function particle_input.<locals>.decorator at 0x000001CC05332B88>, not a test

StanczakDominik · 2019-10-22T05:44:34Z

python setup.py test is no longer supported after we removed the astropy-helpers submodule, use tox -e py36?

diego7319 · 2019-10-22T05:56:47Z

python setup.py test is no longer supported after we removed the astropy-helpers submodule, use tox -e py36?

_______________________________ [doctest] plasmapy.formulary.parameters.Hall_parameter ________________________________ [gw2] win32 -- Python 3.7.4 d:\python\plasmapy\.tox\py36\scripts\python.exe 084 Returns 085 ------- 086 astropy.units.quantity.Quantity 087 088 Examples 089 -------- 090 >>> from astropy import units as u 091 >>> Hall_parameter(1e10 * u.m**-3, 2.8e3 * u.eV, 2.3 * u.T, 'He-4 +1') 092 <Quantity 7.26446755e+16> 093 >>> Hall_parameter(1e10 * u.m**-3, 5.8e3 * u.eV, 2.3 * u.T, 'He-4 +1') Expected: <Quantity 3.25995498e+17> Got: <Quantity 2.11158408e+17>

StanczakDominik · 2019-10-22T06:00:52Z

Yeah, I left a suggestion above implementing that exact change - scroll up! I may have messed up the particle while working my git magic - apologies.

diego7319 · 2019-10-22T06:04:53Z

not problem at all, Im running again tox.
Edit: Passed all the tests. Thanks for your help

StanczakDominik

Looks good, thanks @diego7319 ! :)

jakub-polak · 2020-01-26T19:35:29Z

Consider to update a documentation that tox is now a recommended way to run tests. I was dealing with outdated procedure described in documentation (http://docs.plasmapy.org/en/stable/development/testing_guide.html) before I came across with this post 😸

diego7319 · 2020-01-26T22:23:47Z

Consider to update a documentation that tox is now a recommended way to run tests. I was dealing with outdated procedure described in documentation (http://docs.plasmapy.org/en/stable/development/testing_guide.html) before I came across with this post 😸

like this? assert 2 + 2 == 4, "Addition is broken. Reinstall universe and reboot."

jakub-polak · 2020-01-27T07:35:25Z

Consider to update a documentation that tox is now a recommended way to run tests. I was dealing with outdated procedure described in documentation (http://docs.plasmapy.org/en/stable/development/testing_guide.html) before I came across with this post smile_cat

like this? assert 2 + 2 == 4, "Addition is broken. Reinstall universe and reboot."

Yea, seems to be clear enough 👍

diego7319 changed the title ~~Added examples to the documentation to mass_density and Hall_parameter functions~~ Added examples in documentation to mass_density and Hall_parameter functions Oct 22, 2019

StanczakDominik reviewed Oct 22, 2019

View reviewed changes

plasmapy/formulary/parameters.py Outdated Show resolved Hide resolved

StanczakDominik reviewed Oct 22, 2019

View reviewed changes

plasmapy/formulary/parameters.py Outdated Show resolved Hide resolved

added examples to doc, mass_density and Hall_parameter

8ed818f

changelog file

StanczakDominik reviewed Oct 22, 2019

View reviewed changes

Fixed error Hall_param

a11bbcf

StanczakDominik mentioned this pull request Oct 22, 2019

Have setup.py test/build_docs print a message that people should use tox instead #710

Closed

StanczakDominik approved these changes Oct 22, 2019

View reviewed changes

StanczakDominik changed the title ~~Added examples in documentation to mass_density and Hall_parameter functions~~ Added examples in documentation to mass_density and Hall_parame… Oct 22, 2019

StanczakDominik merged commit 25676b4 into PlasmaPy:master Oct 22, 2019

rocco8773 added plasmapy.formulary Related to the plasmapy.formulary subpackage docs PlasmaPy Docs at http://docs.plasmapy.org labels Jul 9, 2020

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Added examples in documentation to mass_density and Hall_parame… #709

Added examples in documentation to mass_density and Hall_parame… #709

diego7319 commented Oct 22, 2019

codecov bot commented Oct 22, 2019 •

edited

Loading

StanczakDominik commented Oct 22, 2019

diego7319 commented Oct 22, 2019

StanczakDominik commented Oct 22, 2019

StanczakDominik Oct 22, 2019 •

edited

Loading

diego7319 Oct 22, 2019

diego7319 commented Oct 22, 2019

StanczakDominik commented Oct 22, 2019

StanczakDominik commented Oct 22, 2019

StanczakDominik commented Oct 22, 2019

diego7319 commented Oct 22, 2019 •

edited

Loading

StanczakDominik commented Oct 22, 2019

diego7319 commented Oct 22, 2019

StanczakDominik commented Oct 22, 2019

diego7319 commented Oct 22, 2019 •

edited

Loading

StanczakDominik left a comment

jakub-polak commented Jan 26, 2020

diego7319 commented Jan 26, 2020

jakub-polak commented Jan 27, 2020

Added examples in documentation to mass_density and Hall_parame… #709

Added examples in documentation to mass_density and Hall_parame… #709

Conversation

diego7319 commented Oct 22, 2019

codecov bot commented Oct 22, 2019 • edited Loading

Codecov Report

StanczakDominik commented Oct 22, 2019

diego7319 commented Oct 22, 2019

StanczakDominik commented Oct 22, 2019

StanczakDominik Oct 22, 2019 • edited Loading

Choose a reason for hiding this comment

diego7319 Oct 22, 2019

Choose a reason for hiding this comment

diego7319 commented Oct 22, 2019

StanczakDominik commented Oct 22, 2019

StanczakDominik commented Oct 22, 2019

StanczakDominik commented Oct 22, 2019

diego7319 commented Oct 22, 2019 • edited Loading

StanczakDominik commented Oct 22, 2019

diego7319 commented Oct 22, 2019

StanczakDominik commented Oct 22, 2019

diego7319 commented Oct 22, 2019 • edited Loading

StanczakDominik left a comment

Choose a reason for hiding this comment

jakub-polak commented Jan 26, 2020

diego7319 commented Jan 26, 2020

jakub-polak commented Jan 27, 2020

codecov bot commented Oct 22, 2019 •

edited

Loading

StanczakDominik Oct 22, 2019 •

edited

Loading

diego7319 commented Oct 22, 2019 •

edited

Loading

diego7319 commented Oct 22, 2019 •

edited

Loading