From bce6a426f147fbe11c7ec548e469da304b5b98d1 Mon Sep 17 00:00:00 2001
From: Dan Forbes <dan@danforbes.dev>
Date: Fri, 19 Jun 2020 06:55:15 -0700
Subject: [PATCH] Simple Docs for Atomic Swap Pallet (#6434)

* Simple Docs for Atomic Swap Pallet

* Fix copy-and-paste error
---
 substrate/frame/atomic-swap/src/lib.rs | 22 +++++++++++++++++++++-
 1 file changed, 21 insertions(+), 1 deletion(-)

diff --git a/substrate/frame/atomic-swap/src/lib.rs b/substrate/frame/atomic-swap/src/lib.rs
index aa33c9a849f..8686138c2b4 100644
--- a/substrate/frame/atomic-swap/src/lib.rs
+++ b/substrate/frame/atomic-swap/src/lib.rs
@@ -15,7 +15,27 @@
 // See the License for the specific language governing permissions and
 // limitations under the License.
 
-//! # Atomic swap support pallet
+//! # Atomic Swap
+//!
+//! A module for atomically sending funds.
+//!
+//! - [`atomic_swap::Trait`](./trait.Trait.html)
+//! - [`Call`](./enum.Call.html)
+//! - [`Module`](./struct.Module.html)
+//!
+//! ## Overview
+//!
+//! A module for atomically sending funds from an origin to a target. A proof
+//! is used to allow the target to approve (claim) the swap. If the swap is not
+//! claimed within a specified duration of time, the sender may cancel it.
+//!
+//! ## Interface
+//!
+//! ### Dispatchable Functions
+//!
+//! * `create_swap` - called by a sender to register a new atomic swap
+//! * `claim_swap` - called by the target to approve a swap
+//! * `cancel_swap` - may be called by a sender after a specified duration
 
 // Ensure we're `no_std` when compiling for Wasm.
 #![cfg_attr(not(feature = "std"), no_std)]
-- 
GitLab