summaryrefslogtreecommitdiff
path: root/CHANGELOG.md
diff options
context:
space:
mode:
authorAndrew Walbran <qwandor@google.com>2023-11-21 13:51:54 +0000
committerAndrew Walbran <qwandor@google.com>2023-11-29 12:08:37 +0000
commit8b6e102a3f001b81872659c2df1f3ddddc6259c6 (patch)
tree788c9fd5c653baf26b4ab028e66c943706f385f7 /CHANGELOG.md
parent4a8fed6fe06422c57827ecda7a09009feb77ef10 (diff)
downloaddisplaydoc-8b6e102a3f001b81872659c2df1f3ddddc6259c6.tar.gz
Import displaydoc crate.upstream
Request Document: go/android-rust-importing-crates For CL Reviewers: go/android3p#cl-review For Build Team: go/ab-third-party-imports Bug: 312432303 Test: Treehugger Change-Id: I77f25d4c9c365b618d24e5b0c041e7d857ff6435
Diffstat (limited to 'CHANGELOG.md')
-rw-r--r--CHANGELOG.md50
1 files changed, 50 insertions, 0 deletions
diff --git a/CHANGELOG.md b/CHANGELOG.md
new file mode 100644
index 0000000..4513b4a
--- /dev/null
+++ b/CHANGELOG.md
@@ -0,0 +1,50 @@
+# Changelog
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+<!-- next-header -->
+
+## [Unreleased] - ReleaseDate
+
+# [0.2.4] - 2022-05-02
+
+## Added
+- Updated `syn` dependency to 2.0
+- Support for empty enums
+- Implicitly require fmt::Display on all type parameters unless overridden
+
+## Changed
+- Bumped MSRV to 1.56
+
+# [0.2.3] - 2021-07-16
+## Added
+- Added `#[displaydoc("..")]` attribute for overriding a doc comment
+
+# [0.2.2] - 2021-07-01
+## Added
+- Added prefix feature to use the doc comment from an enum and prepend it
+ before the error message from each variant.
+
+# [0.2.1] - 2021-03-26
+## Added
+- Added opt in support for ignoring extra doc attributes
+
+# [0.2.0] - 2021-03-16
+## Changed
+
+- (BREAKING) disallow multiple `doc` attributes in display impl
+ [https://github.com/yaahc/displaydoc/pull/22]. Allowing and ignoring extra
+ doc attributes made it too easy to accidentally create a broken display
+ implementation with missing context without realizing it, this change turns
+ that into a hard error and directs users towards block comments if multiple
+ lines are needed.
+
+<!-- next-url -->
+[Unreleased]: https://github.com/yaahc/displaydoc/compare/v0.2.4...HEAD
+[0.2.4]: https://github.com/yaahc/displaydoc/compare/v0.2.3...v0.2.4
+[0.2.3]: https://github.com/yaahc/displaydoc/compare/v0.2.2...v0.2.3
+[0.2.2]: https://github.com/yaahc/displaydoc/compare/v0.2.1...v0.2.2
+[0.2.1]: https://github.com/yaahc/displaydoc/compare/v0.2.0...v0.2.1
+[0.2.0]: https://github.com/yaahc/displaydoc/releases/tag/v0.2.0