Skip to content

Commit 1d59c83

Browse files
committed
DOC: add human-readable CHANGELOG
1 parent 5ee28c4 commit 1d59c83

File tree

1 file changed

+43
-0
lines changed

1 file changed

+43
-0
lines changed

CHANGELOG.md

Lines changed: 43 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,43 @@
1+
# Release notes
2+
3+
## Unreleased - Version 3.0.0
4+
5+
Notable differences from version 1.3.5.
6+
7+
### Added
8+
9+
- Compatibility with Python 3.7, 3.6, 3.5 in addition to 2.7.
10+
- Aliases for 17 non-standard space group names from cctbx.
11+
- Support for intersphinx links to Python and NumPy documentation.
12+
- Dependency and use of the `six` PY2/PY3 compatibility package.
13+
- Documentation hosting at readthedocs.org.
14+
15+
### Changed
16+
17+
- Rename the package and all its module names to lowercase.
18+
- Use UTF-8 encoding when writing structure files.
19+
- Refactor parsing of XCFG format. Avoid use of generated code.
20+
- Refactor all starred imports to explicit so they can be checked.
21+
- Adopt napoleon style for docstrings.
22+
- Update docstrings for `Atom`, `Lattice`, `SymOp`, `SpaceGroup`.
23+
- Switch to platform-independent "noarch" Anaconda package.
24+
25+
### Deprecated
26+
27+
- Old camel case module names such as `diffpy.Structure`.
28+
- Variable `__gitsha__` in the `version` module which was renamed
29+
to `__git_commit__`.
30+
31+
### Removed
32+
33+
- Unused exception `IsotropyError`.
34+
- Unused class `BRAtomsStructure` and associated parser.
35+
36+
### Fixed
37+
38+
- Loading of empty CIF files with no specified sites.
39+
- Parsing of CIFs with `?` value for unknown displacement parameters.
40+
- Symmetry constraint equations for ADPs so they avoid self-reference.
41+
- Use `StructureFormatError` exception for CIF with unknown space group.
42+
- Open files within the `with` context so they get closed when done.
43+
- Invalid escape sequences in string values.

0 commit comments

Comments
 (0)