no exec

Author: juleswritescode

crates/pgt_workspace_macros/src/lib.rs

@@ -33,9 +33,12 @@ impl syn::parse::Parse for IgnoredPath {
 /// You can use this on a workspace server function to return a default if the specified path
 /// is ignored by the user's settings.
 ///
+/// This will work for any function where &self is in scope and that returns `Result<T, E>`, `Result<(), E>`, or `T`, where `T: Default`.
+/// `path` needs to point at a `&PgTPath``.
 ///
-/// Usage:
-/// ```
+/// ### Usage
+///
+/// ```ignore
 /// impl WorkspaceServer {
 ///   #[ignore_path(path=&params.path)]
 ///   fn foo(&self, params: FooParams) -> Result<FooResult, WorkspaceError> {
@@ -54,8 +57,6 @@ impl syn::parse::Parse for IgnoredPath {
 ///   }
 /// }
 /// ```
-///
-/// This will work for any function where &self is in scope and that returns `Result<T, E>`, `Result<(), E>`, or `T`, where `T: Default`.
 pub fn ignored_path(args: TokenStream, input: TokenStream) -> TokenStream {
     let ignored_path = parse_macro_input!(args as IgnoredPath);
     let input_fn = parse_macro_input!(input as syn::ItemFn);