define decorator @preserve_signature
#640
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
…e parameter hints of decorated functions
* Add ExB drift * Add force drift * Cleanup code, fixup documentation * Add examples * Pep8 fixes * @namurphy review fixes
* use pprint * Improve plot legends * pep8 fixes I also need to trigger travis
The roadmap has been out of date for a while, and we decided that it would be better to pull it out of the main repository so that it could be updated and versioned separately.
* Remove obsolete top-level INSTALL.md file We originally kept our installation directions in this file, but have since moved the information to our docs directory. We kept this file in case it was linked to from anywhere else on the World Wide Web, but it has been a long enough time that we can safely remove it. * Update setup.cfg * Update citation information A recommended practice for scientific reproducibility is to cite the specific version of software used for a project, and an established practice is to cite a paper or informational resource that describes it. This commit updates CITATION.rst and the near-identical docs/about/citation.rst to include both of these references. We previously decided to keep both of these files despite the duplication to make it extra apparent how to cite PlasmaPy. I changed plasmapy.__citation__ to be a list of DOI links, including the standard reference from 2018 and version 0.2.0. The metadata for our releases on Zenodo could potentially change (for example, adding the name of a contributor that wasn't known before), so a DOI is the most robust way to go about it. I reserved the DOI for version 0.2.0 on Zenodo, so the links to that will not work yet.
* README * Improved readme * add feedback form link * Add communication info to documentation
* post v0.2.0 cleanup * Update version in docs
…`preserve_signature`
…; import `preserve_signature`
update master from PlasmaPy master
|
Hello @rocco8773! Thanks for updating your pull request. Congratulations! There are no PEP8 issues in this pull request. 😸 Comment last updated at 2019-06-12 00:36:40 UTC |
Codecov Report
@@ Coverage Diff @@
## master #640 +/- ##
==========================================
+ Coverage 96.5% 96.51% +<.01%
==========================================
Files 52 54 +2
Lines 4551 4561 +10
==========================================
+ Hits 4392 4402 +10
Misses 159 159
Continue to review full report at Codecov.
|
StanczakDominik
approved these changes
Jun 12, 2019
| @@ -1,8 +1,16 @@ | |||
| """ | |||
| Package of functions and classes used to develop clean, readable, and informative | |||
| code. | |||
|
@StanczakDominik It is a rebase gone wrong. It happened when I brought PlasmaPy/master into my fork. I'm not exactly sure what happened. If it's easy enough to just squash this onto master, then 👍. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Create a decorator for decorators, which preserves the signature of the function being wrapped such that IDE function parameter hints still work for the wrapped function (see issue #619).
This PR does the following:
plasmapy.utils.decoratorsto house various plasmapy decoratorsplasmapy.utils.checks.pyshould be moved here (as a separate PR)plamsapy.utils.decorators.helpers.pyas a place where miscellaneous decorators can be definedpreserve_signature(inhelpers.py)preserve_signaturewith testscheck_quantityandcheck_relativisticto utilizepreserve_signatureautomodapiofplasmapy.utils.decoratorsto documentation filedocs/utils/index.rst