Skip to content

Commit

Permalink
docs: Update docs to track major version updates.
Browse files Browse the repository at this point in the history
  • Loading branch information
jheer committed Oct 24, 2024
1 parent c61723b commit 755a0d3
Show file tree
Hide file tree
Showing 4 changed files with 60 additions and 90 deletions.
11 changes: 3 additions & 8 deletions docs/api/extensibility.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,11 +10,6 @@ title: Extensibility \| Arquero API Reference
* [addAggregateFunction](#addAggregateFunction)
* [addWindowFunction](#addWindowFunction)
* [Table Methods](#table-methods)
* [addTableMethod](#addTableMethod)
* [addVerb](#addVerb)
* [Package Bundles](#packages)
* [addPackage](#addPackage)
* [Table Methods](#table-methods)

<br/>

Expand All @@ -23,7 +18,7 @@ title: Extensibility \| Arquero API Reference
Add new functions for use in table expressions.

<hr/><a id="addFunction" href="#addFunction">#</a>
<em>aq</em>.<b>addFunction</b>([<i>name</i>,] <i>fn</i>[, <i>options</i>]) · [Source](https://github.com/uwdata/arquero/blob/master/src/register.js)
<em>aq</em>.<b>addFunction</b>([<i>name</i>,] <i>fn</i>[, <i>options</i>]) · [Source](https://github.com/uwdata/arquero/blob/master/src/op/register.js)

Register a function for use within table expressions. If only a single argument is provided, it will be assumed to be a function and the system will try to extract its name. Throws an error if a function with the same name is already registered and the override option is not specified, or if no name is provided and the input function is anonymous. After registration, the function will be accessible via the [`op`](#op) object.

Expand Down Expand Up @@ -54,7 +49,7 @@ aq.addFunction(function square(x) { return x * x; });


<hr/><a id="addAggregateFunction" href="#addAggregateFunction">#</a>
<em>aq</em>.<b>addAggregateFunction</b>(<i>name</i>, <i>def</i>[, <i>options</i>]) · [Source](https://github.com/uwdata/arquero/blob/master/src/register.js)
<em>aq</em>.<b>addAggregateFunction</b>(<i>name</i>, <i>def</i>[, <i>options</i>]) · [Source](https://github.com/uwdata/arquero/blob/master/src/op/register.js)

Register a custom aggregate function. Throws an error if a function with the same name is already registered and the override option is not specified. After registration, the operator will be accessible via the [`op`](#op) object.

Expand Down Expand Up @@ -92,7 +87,7 @@ aq.table({ x: [1, 2, 3] })
<hr/><a id="addWindowFunction" href="#addWindowFunction">#</a>
<em>aq</em>.<b>addWindowFunction</b>(<i>name</i>, <i>def</i>[, <i>options</i>]) · [Source](https://github.com/uwdata/arquero/blob/master/src/register.js)
<em>aq</em>.<b>addWindowFunction</b>(<i>name</i>, <i>def</i>[, <i>options</i>]) · [Source](https://github.com/uwdata/arquero/blob/master/src/op/register.js)
Register a custom window function. Throws an error if a function with the same name is already registered and the override option is not specified. After registration, the operator will be accessible via the [`op`](#op) object.
Expand Down
2 changes: 1 addition & 1 deletion docs/api/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -177,7 +177,7 @@ aq.fromCSV(await fetch(url).then(res => res.text()))
<hr/><a id="fromFixed" href="#fromFixed">#</a>
<em>aq</em>.<b>fromFixed</b>(<i>text</i>[, <i>options</i>]) · [Source](https://github.com/uwdata/arquero/blob/master/src/format/from-fixed-width.js)
<em>aq</em>.<b>fromFixed</b>(<i>text</i>[, <i>options</i>]) · [Source](https://github.com/uwdata/arquero/blob/master/src/format/from-fixed.js)
Parse a fixed-width file *text* string into a <a href="table">table</a>. By default, automatic type inference is performed for input values; string values that match the ISO standard date format are parsed into JavaScript Date objects. To disable this behavior set *options.autoType* to `false`, which will cause all columns to be loaded as strings. To perform custom parsing of input column values, use *options.parse*.
Expand Down
Loading

0 comments on commit 755a0d3

Please sign in to comment.