diff --git a/appveyor.yml b/appveyor.yml index 413e403..3fecf4e 100755 --- a/appveyor.yml +++ b/appveyor.yml @@ -1,7 +1,8 @@ init: - git config --global core.autocrlf input +image: Visual Studio 2017 build_script: - - cmd: build.cmd All + - cmd: build.cmd test: off version: 0.0.1.{build} artifacts: diff --git a/docs/content/index.fsx b/docs/content/index.fsx index e30031c..4ac8b13 100755 --- a/docs/content/index.fsx +++ b/docs/content/index.fsx @@ -4,7 +4,7 @@ #I "../../build_output" (** -Functional F# API on top of official C# driver +Functional F# API for Cassandra ====================== FsCassy offers several improvements for F# expereience over the .NET driver: F# quotations support for statically-typed update queries, a composable DSL for statements and diff --git a/docs/content/tutorial.fsx b/docs/content/tutorial.fsx index d0e2634..2b2d3dd 100755 --- a/docs/content/tutorial.fsx +++ b/docs/content/tutorial.fsx @@ -86,14 +86,14 @@ Interpreters Interpreters parse statements and carry out the actual work, following functions are available: -- Cassandra interpreter +- Cassandra interpreter
Cassandra interpreter uses [Table API](http://datastax.github.io/csharp-driver/features/components/linq/) and relies on the same type mapping facilities. -- Pretty printer +- Pretty printer
Humand-readable rough approximmation of the statement and it's arguments. -- In-Mem interpreter +- In-Mem interpreter
Executes statements against a predefined list. diff --git a/docs/tools/generate.fsx b/docs/tools/generate.fsx index 450d4d6..9925c60 100644 --- a/docs/tools/generate.fsx +++ b/docs/tools/generate.fsx @@ -11,7 +11,7 @@ // (This is the original behaviour of ProjectScaffold prior to multi project support) let referenceBinaries = ["FsCassy.dll"] // Web site location for the generated documentation -let website = "/" +let website = "https://prolucid.github.io/FsCassy" let githubLink = "https://github.com/Prolucid/FsCassy" @@ -137,9 +137,5 @@ let buildDocumentation () = // Generate copyFiles() -#if HELP buildDocumentation() -#endif -#if REFERENCE buildReference() -#endif diff --git a/docs/tools/templates/template.cshtml b/docs/tools/templates/template.cshtml index 1ae4a1b..16045e8 100755 --- a/docs/tools/templates/template.cshtml +++ b/docs/tools/templates/template.cshtml @@ -23,6 +23,7 @@
diff --git a/src/FsCassy/Cassandra.fs b/src/FsCassy/Cassandra.fs index 55c0bac..315d646 100644 --- a/src/FsCassy/Cassandra.fs +++ b/src/FsCassy/Cassandra.fs @@ -5,6 +5,9 @@ open System.Linq open System.Linq.Expressions open FsCassy + +/// Converts F# record updates into C#-like property assignments that +/// the .NET driver expects module ExpressionTranslator = open System.Reflection @@ -41,6 +44,7 @@ module ExpressionTranslator = | _ -> x extract Seq.empty Seq.empty x +/// Convinience helpers on top of official API [] [] module Api = @@ -65,6 +69,7 @@ module Api = memoize (fun (session:ISession) -> Table<'t>(session,mappingConfiguration)) +/// Executes the statements using Cassandra Table and Mapper APIs module Interpreter = open System.Threading.Tasks open Cassandra diff --git a/src/FsCassy/InMem.fs b/src/FsCassy/InMem.fs index f3b367c..712592f 100644 --- a/src/FsCassy/InMem.fs +++ b/src/FsCassy/InMem.fs @@ -1,3 +1,4 @@ +/// InMem implementation for testing module FsCassy.InMem open System open System.Linq