Comments

src/FsCodec.NewtonsoftJson/Codec.fs

@@ -47,7 +47,7 @@ module Core =
  use jsonReader = Utf8BytesEncoder.makeJsonReader ms
  serializer.Deserialize<'T>(jsonReader)
 
-// Provides Codecs that render to a UTF-8 array suitable for storage in Event Stores based using <c>Newtonsoft.Json</c> and the conventions implied by using
+/// Provides Codecs that render to a UTF-8 array suitable for storage in Event Stores based using <c>Newtonsoft.Json</c> and the conventions implied by using
 /// <c>TypeShape.UnionContract.UnionContractEncoder</c> - if you need full control and/or have have your own codecs, see <c>FsCodec.Codec.Create</c> instead
 /// See <a href=""https:/eiriktsarpalis/TypeShape/blob/master/tests/TypeShape.Tests/UnionContractTests.fs"></a> for example usage.
 type Codec private () =

src/FsCodec/Codec.fs

@@ -22,8 +22,8 @@ type Codec =
  member __.TryDecode ie =
  tryDecode ie }
 
- /// Generate a <code>IUnionEncoder</code> Codec suitable using the supplied pair of <c>encode</c> and <c>tryDecode</code> functions.
- /// <c>mapCausation</c> provides correlation/causationId mapping
+ /// Generate a <code>IUnionEncoder</code> Codec suitable using the supplied <c>encode</c> and <c>tryDecode</code> functions to map to/from UTF8.
+ /// <c>mapCausation</c> provides metadata generation and correlation/causationId mapping based on the Context passed to the encoder
  static member Create<'Union,'Context>
  ( /// Maps from the TypeShape <c>UnionConverter</c> <c>'Contract</c> case the Event has been mapped to (with the raw event data as context)
  /// to the representation (typically a Discriminated Union) that is to be presented to the programming model.