Fix XML doc comments for renameCol and renameColsUsing to use proper XML format

github-actions[bot] · Copilot · github-actions[bot] · commit f147d6d9e8c1 · 2026-03-09T13:16:47.000Z
Convert Markdown-style doc comments (## Parameters, [category:...]) to proper
XML doc comment format (&lt;summary&gt;, &lt;param&gt;, &lt;category&gt;) consistent with the
rest of FrameModule.fs.

Co-authored-by: Copilot &lt;223556219+Copilot@users.noreply.github.com&gt;
diff --git a/src/Deedle/FrameModule.fs b/src/Deedle/FrameModule.fs
@@ -778,28 +778,26 @@ module Frame =
     if Seq.length frame.ColumnKeys <> Seq.length keys then invalidArg "keys" "New keys do not match current column index length"
     Frame<_, _>(frame.RowIndex, Index.ofKeys (ReadOnlyCollection.ofSeq keys), frame.Data, frame.IndexBuilder, frame.VectorBuilder)
 
+  /// <summary>
   /// Rename a single column of the data frame. Returns a new frame; does not mutate the
-  /// original. If `oldKey` is not found, the frame is returned unchanged.
-  ///
-  /// ## Parameters
-  ///  - `oldKey` - The current key of the column to rename.
-  ///  - `newKey` - The new key to assign to that column.
-  ///  - `frame` - Source data frame (which is not mutated by the operation).
-  ///
-  /// [category:Sorting and index manipulation]
+  /// original. If <c>oldKey</c> is not found, the frame is returned unchanged.
+  /// </summary>
+  /// <param name="oldKey">The current key of the column to rename.</param>
+  /// <param name="newKey">The new key to assign to that column.</param>
+  /// <param name="frame">Source data frame (which is not mutated by the operation).</param>
+  /// <category>Sorting and index manipulation</category>
   [<CompiledName("RenameColumn")>]
   let renameCol oldKey newKey (frame:Frame<'R, 'C>) =
     let newKeys = frame.ColumnKeys |> Seq.map (fun k -> if k = oldKey then newKey else k)
     Frame<_, _>(frame.RowIndex, Index.ofKeys (ReadOnlyCollection.ofSeq newKeys), frame.Data, frame.IndexBuilder, frame.VectorBuilder)
 
+  /// <summary>
   /// Rename all columns of the data frame by applying the specified mapping function.
   /// Returns a new frame; does not mutate the original.
-  ///
-  /// ## Parameters
-  ///  - `mapping` - A function that maps each current column key to a new column key.
-  ///  - `frame` - Source data frame (which is not mutated by the operation).
-  ///
-  /// [category:Sorting and index manipulation]
+  /// </summary>
+  /// <param name="mapping">A function that maps each current column key to a new column key.</param>
+  /// <param name="frame">Source data frame (which is not mutated by the operation).</param>
+  /// <category>Sorting and index manipulation</category>
   [<CompiledName("RenameColumns")>]
   let renameColsUsing (mapping:'C -> 'C2) (frame:Frame<'R, 'C>) =
     Frame<_, _>(frame.RowIndex, Index.ofKeys (ReadOnlyCollection.map mapping frame.ColumnIndex.Keys), frame.Data, frame.IndexBuilder, frame.VectorBuilder)
