Skip to content
This repository was archived by the owner on Aug 16, 2021. It is now read-only.

Commit c5159dc

Browse files
faernYamakaky
authored andcommitted
Hide error_chain_processed macro from docs (#212)
* Hide error_chain_processed from docs Fixes #185 * Update changelog * Rename error_chain_processed to match other macros
1 parent bac8d49 commit c5159dc

File tree

2 files changed

+7
-6
lines changed

2 files changed

+7
-6
lines changed

CHANGELOG.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,7 @@
88
- [Allow `chain_err` to be used on `Option<T>`](https://github.com/rust-lang-nursery/error-chain/pull/156)
99
- [Add support for creating an error chain on boxed trait errors (`Box<Error>`)](https://github.com/rust-lang-nursery/error-chain/pull/156)
1010
- [Remove lint for unused doc comment.](https://github.com/rust-lang-nursery/error-chain/pull/199)
11+
- [Hide error_chain_processed macro from documentation.](https://github.com/rust-lang-nursery/error-chain/pull/212)
1112

1213
# 0.10.0
1314

src/error_chain.rs

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,13 @@
11
/// Prefer to use `error_chain` instead of this macro.
2+
#[doc(hidden)]
23
#[macro_export]
3-
macro_rules! error_chain_processed {
4+
macro_rules! impl_error_chain_processed {
45
// Default values for `types`.
56
(
67
types {}
78
$( $rest: tt )*
89
) => {
9-
error_chain_processed! {
10+
impl_error_chain_processed! {
1011
types {
1112
Error, ErrorKind, ResultExt, Result;
1213
}
@@ -21,7 +22,7 @@ macro_rules! error_chain_processed {
2122
}
2223
$( $rest: tt )*
2324
) => {
24-
error_chain_processed! {
25+
impl_error_chain_processed! {
2526
types {
2627
$error_name, $error_kind_name,
2728
$result_ext_name;
@@ -391,7 +392,7 @@ macro_rules! error_chain_processing {
391392
}
392393
};
393394
( ($a:tt, $b:tt, $c:tt, $d:tt) ) => {
394-
error_chain_processed! {
395+
impl_error_chain_processed! {
395396
types $a
396397
links $b
397398
foreign_links $c
@@ -400,8 +401,7 @@ macro_rules! error_chain_processing {
400401
};
401402
}
402403

403-
/// This macro is used for handling of duplicated and out-of-order fields. For
404-
/// the exact rules, see `error_chain_processed`.
404+
/// Macro for generating error types and traits. See crate level documentation for details.
405405
#[macro_export]
406406
macro_rules! error_chain {
407407
( $( $block_name:ident { $( $block_content:tt )* } )* ) => {

0 commit comments

Comments
 (0)