From 6fd754fba06ab3e3c4447fe118e780aa5040a419 Mon Sep 17 00:00:00 2001
From: David Sherret <dsherret@users.noreply.github.com>
Date: Tue, 28 Apr 2020 17:26:31 -0400
Subject: Move the docs like `@param [obj.prop]` to the interface. (#4974)

---
 std/encoding/csv.ts | 28 ++++++++++++++--------------
 1 file changed, 14 insertions(+), 14 deletions(-)

(limited to 'std/encoding/csv.ts')

diff --git a/std/encoding/csv.ts b/std/encoding/csv.ts
index ae86e25bb..75763f2c6 100644
--- a/std/encoding/csv.ts
+++ b/std/encoding/csv.ts
@@ -264,6 +264,20 @@ export interface HeaderOptions {
 
 export interface ParseOptions extends ReadOptions {
   header: boolean | string[] | HeaderOptions[];
+  /** Parse function for rows.
+   * Example:
+   *     const r = await parseFile('a,b,c\ne,f,g\n', {
+   *      header: ["this", "is", "sparta"],
+   *       parse: (e: Record<string, unknown>) => {
+   *         return { super: e.this, street: e.is, fighter: e.sparta };
+   *       }
+   *     });
+   * // output
+   * [
+   *   { super: "a", street: "b", fighter: "c" },
+   *   { super: "e", street: "f", fighter: "g" }
+   * ]
+   */
   parse?: (input: unknown) => unknown;
 }
 
@@ -273,20 +287,6 @@ export interface ParseOptions extends ReadOptions {
  * for columns and rows.
  * @param input Input to parse. Can be a string or BufReader.
  * @param opt options of the parser.
- * @param [opt.header=false] HeaderOptions
- * @param [opt.parse=null] Parse function for rows.
- * Example:
- *     const r = await parseFile('a,b,c\ne,f,g\n', {
- *      header: ["this", "is", "sparta"],
- *       parse: (e: Record<string, unknown>) => {
- *         return { super: e.this, street: e.is, fighter: e.sparta };
- *       }
- *     });
- * // output
- * [
- *   { super: "a", street: "b", fighter: "c" },
- *   { super: "e", street: "f", fighter: "g" }
- * ]
  */
 export async function parse(
   input: string | BufReader,
-- 
cgit v1.2.3