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.

Sign up for GitHub

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

Jump to bottom

DOC: Update documentation for Data and Material #104

Merged
merged 3 commits into from Feb 17, 2017
Merged

DOC: Update documentation for Data and Material #104

merged 3 commits into from Feb 17, 2017

Conversation

pseudocubic
Copy link
Contributor

Updated the Data and Material class documentation to reflect most current proper usage of these classes

Resolves #100
Resolves #103

David M Fobes added 2 commits February 16, 2017 14:23
DOC: Updated Data examples
3fdb435 
Updated Example document for `Data` class usage.

Updated docstring in `load_data` method

Resolves #100
DOC: Update examples for Materials class
14346bd 
Updated Material Example documentation to clarify the proper usage of the `massNorm` key.

Updated docstring for `Material` class to indicate proper usage of the `massNorm` key.

Resolves #103
@pseudocubic pseudocubic self-assigned this Feb 16, 2017
@codecov-io
Copy link

codecov-io commented Feb 17, 2017 •
edited

Codecov Report

Merging #104 into master will increase coverage by 0.1%.
The diff coverage is n/a.

@@            Coverage Diff            @@
##           master     #104     +/-   ##
=========================================
+ Coverage   84.09%   84.19%   +0.1%     
=========================================
  Files          47       47             
  Lines        3886     3917     +31     
=========================================
+ Hits         3268     3298     +30     
- Misses        618      619      +1
Impacted Files Coverage Δ
neutronpy/crystal/material.py 72.81% <ø> (ø) ✅
neutronpy/fileio/data.py 87.03% <ø> (ø) ✅
neutronpy/data/scans.py 91.74% <ø> (+1.99%) ✅

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 bf0ae96...c815a34. Read the comment docs.

@pseudocubic pseudocubic merged commit d31671b into neutronpy:master Feb 17, 2017
@pseudocubic pseudocubic deleted the doc/fileio-namespace-update branch February 17, 2017 15:54
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers
No reviews
Assignees

@pseudocubic pseudocubic

Labels
component: core component: form_facs documentation
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

None yet
2 participants
@pseudocubic @codecov-io