Improve unimpl! docs

bjorn3 · bjorn3 · commit e77f1185a1b6 · 2019-03-03T11:02:32.000+01:00
diff --git a/src/unimpl.rs b/src/unimpl.rs
@@ -14,8 +14,12 @@ thread_local! {
 }
 
 // Just public, because of the unimpl macro
+#[doc(hidden)]
 pub struct NonFatal(pub String);
 
+/// Use when something in the current function is unimplemented.
+///
+/// This will emit an error and continue codegen at a different function.
 pub macro unimpl($($tt:tt)*) {
     panic!(NonFatal(format!($($tt)*)));
 }

Original file line number	Diff line number	Diff line change
`@@ -14,8 +14,12 @@ thread_local! {`
`14`	`14`	`}`
`15`	`15`
`16`	`16`	`// Just public, because of the unimpl macro`
	`17`	`+#[doc(hidden)]`
`17`	`18`	`pub struct NonFatal(pub String);`
`18`	`19`
	`20`	`+/// Use when something in the current function is unimplemented.`
	`21`	`+///`
	`22`	`+/// This will emit an error and continue codegen at a different function.`
`19`	`23`	`pub macro unimpl($($tt:tt)*) {`
`20`	`24`	`panic!(NonFatal(format!($($tt)*)));`
`21`	`25`	`}`