Skip to content

Document EBSD reference frames#215

Merged
hakonanes merged 13 commits into
pyxem:masterfrom
hakonanes:complete-ebsddetector-tests-documentation
Sep 15, 2020
Merged

Document EBSD reference frames#215
hakonanes merged 13 commits into
pyxem:masterfrom
hakonanes:complete-ebsddetector-tests-documentation

Conversation

@hakonanes
Copy link
Copy Markdown
Member

@hakonanes hakonanes commented Sep 10, 2020

Signed-off-by: Håkon Wiik Ånes hwaanes@gmail.com

Description of the change

Closes #208 and #211.

Progress of the PR

  • Docstrings for all functions with examples!
  • Unit tests with pytest for all lines in ebsd_detector.py
  • Clean style in as per black
  • Double check conversions between vendor projection center conventions (Jackson et al. (2019)).
  • Continue on the reference frame part of the documentation, with clear explanations of how to use the EBSDDetector class
  • Add detector stuff to the API

For reviewers

  • Check that the PR title is short, concise, and will make sense 1 year
    later.
  • Check that new functions are imported in corresponding __init__.py.
  • Check that new features, API changes, and deprecations are mentioned in
    the unreleased section in doc/changelog.rst.

Signed-off-by: Håkon Wiik Ånes <hwaanes@gmail.com>
@hakonanes hakonanes added this to the v0.3.0 milestone Sep 10, 2020
@hakonanes hakonanes self-assigned this Sep 10, 2020
@hakonanes hakonanes added the documentation This relates to the documentation label Sep 10, 2020
@hakonanes hakonanes changed the title Almost finish testing of EBSDDetector, fix some errors Complete tests of EBSDDetector class, add to API, improve reference frames documentation Sep 10, 2020
Signed-off-by: Håkon Wiik Ånes <hwaanes@gmail.com>
@hakonanes hakonanes marked this pull request as draft September 11, 2020 17:33
Signed-off-by: Håkon Wiik Ånes <hwaanes@gmail.com>
Signed-off-by: Håkon Wiik Ånes <hwaanes@gmail.com>
Signed-off-by: Håkon Wiik Ånes <hwaanes@gmail.com>
Signed-off-by: Håkon Wiik Ånes <hwaanes@gmail.com>
Signed-off-by: Håkon Wiik Ånes <hwaanes@gmail.com>
Signed-off-by: Håkon Wiik Ånes <hwaanes@gmail.com>
Signed-off-by: Håkon Wiik Ånes <hwaanes@gmail.com>
@hakonanes hakonanes changed the title Complete tests of EBSDDetector class, add to API, improve reference frames documentation Document EBSD reference frames Sep 14, 2020
Signed-off-by: Håkon Wiik Ånes <hwaanes@gmail.com>
@hakonanes hakonanes marked this pull request as ready for review September 14, 2020 16:44
Signed-off-by: Håkon Wiik Ånes <hwaanes@gmail.com>
Signed-off-by: Håkon Wiik Ånes <hwaanes@gmail.com>
…lete-ebsddetector-tests-documentation

Signed-off-by: Håkon Wiik Ånes <hwaanes@gmail.com>
@hakonanes hakonanes merged commit c241438 into pyxem:master Sep 15, 2020
@hakonanes hakonanes deleted the complete-ebsddetector-tests-documentation branch September 15, 2020 18:31
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation This relates to the documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Complete tests and documentation of the EBSDDetector class

1 participant