From 06aa9e31754f260290afe62aac02d2238b43e3c0 Mon Sep 17 00:00:00 2001
From: Charles Chege <charleschege@protonmail.ch>
Date: Fri, 29 Oct 2021 10:36:18 +0300
Subject: [PATCH] Document the macros. Add code examples for the macros

---
 sea-orm-macros/src/derives/column.rs | 3 +--
 sea-orm-macros/src/lib.rs            | 5 ++++-
 2 files changed, 5 insertions(+), 3 deletions(-)

diff --git a/sea-orm-macros/src/derives/column.rs b/sea-orm-macros/src/derives/column.rs
index ed035e0b..8e60c560 100644
--- a/sea-orm-macros/src/derives/column.rs
+++ b/sea-orm-macros/src/derives/column.rs
@@ -3,8 +3,7 @@ use proc_macro2::{Ident, TokenStream};
 use quote::{quote, quote_spanned};
 use syn::{punctuated::Punctuated, token::Comma, Data, DataEnum, Fields, Lit, Meta, Variant};
 
-/// FIXME
-/// Method to derive default column names from a &str
+/// Derive a Column name for an enum type
 pub fn impl_default_as_str(ident: &Ident, data: &Data) -> syn::Result<TokenStream> {
     let variants = match data {
         syn::Data::Enum(DataEnum { variants, .. }) => variants,
diff --git a/sea-orm-macros/src/lib.rs b/sea-orm-macros/src/lib.rs
index bdc52f0f..87ac07d0 100644
--- a/sea-orm-macros/src/lib.rs
+++ b/sea-orm-macros/src/lib.rs
@@ -106,12 +106,15 @@ pub fn derive_column(input: TokenStream) -> TokenStream {
 }
 
 /// Derive a column if column names are not in snake-case
+/// ### Usage
+/// ```
 /// #[derive(Copy, Clone, Debug, EnumIter, DeriveCustomColumn)]
 /// pub enum Column {
 ///     Id,
 ///     Name,
 ///     VendorId,
 /// }
+/// ```
 #[proc_macro_derive(DeriveCustomColumn)]
 pub fn derive_custom_column(input: TokenStream) -> TokenStream {
     let DeriveInput { ident, data, .. } = parse_macro_input!(input);
@@ -165,7 +168,7 @@ pub fn derive_active_model(input: TokenStream) -> TokenStream {
     }
 }
 
-/// FIXME Derive into an active model
+/// Derive into an active model
 #[proc_macro_derive(DeriveIntoActiveModel, attributes(sea_orm))]
 pub fn derive_into_active_model(input: TokenStream) -> TokenStream {
     let input = parse_macro_input!(input as DeriveInput);