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

start the release notes #73

Merged
merged 3 commits into from
Dec 20, 2020
Merged

start the release notes #73

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
b2652eb
DOC #72 start the release notes
prjemian Dec 18, 2020
ca2ca51
MNT #73 add spec2nexus
prjemian Dec 20, 2020
ff8b1cc
fix #74 provide version in package
prjemian Dec 20, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion docs/source/index.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -42,4 +42,4 @@ Contents:
sample
util
examples/*

release_notes
65 changes: 65 additions & 0 deletions docs/source/release_notes.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,65 @@
===============
Release History
===============

.. subsections could include these headings (in this order)

Breaking Changes
New Features and/or Enhancements
Fixes
Maintenance
Deprecations

v1.0.0 (tba)
============

Consult the 1.0.0 milestone [#]_ on GitHub for an expected
release date.

.. [#] https://github.com/bluesky/hklpy/milestone/5

v0.3.15 (2020-12-21)
====================

Breaking Changes
----------------

* Diffractometer wavelength **must** use *angstrom* units to match the
lattice constants. Previously, wavelength was stated to be in
`nm`. Instruments upgrading to this release should verify the units
actually in use.

New Features and/or Enhancements
--------------------------------

* Diffractometer energy units can be specified. Unit conversions
are handled by the *pint* [#]_ package.
prjemian marked this conversation as resolved.
Show resolved Hide resolved

* Examples of E4CV, K4CV, and E6C diffractometer geometries.
* Comparison of UB matrix calculation with SPEC data.
* Source code documentation in `hkl.diffract`.
* Show how to connect energy from local controls.

.. [#] *pint*: https://pint.readthedocs.io/en/stable/

Fixes
-----

* Limits-checking for *hkl* values now coordinated with upstream
``bluesky`` code.

Maintenance
-----------

* Move continuous integration processes to GitHub Actions.
* Documentation now published with other bluesky packages:
https://blueskyproject.io/hklpy/

Deprecations
------------

* All the previous examples have been archived and will be
removed for the 1.0.0 release.

v0.3.14 (2020-09-28)
====================