Skip to content

Conversation

@AndreiKingsley
Copy link
Collaborator

@AndreiKingsley AndreiKingsley commented Nov 7, 2025

Closes #1525

@AndreiKingsley AndreiKingsley marked this pull request as ready for review November 7, 2025 15:21
@ExcludeFromSources
interface OPERATION

/**
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

to make it clearer this is a comment about RECEIVER and not some KDoc to include somewhere else I'd use "gray" comments for arguments

*
* ### Create [Pivot]
*
* [**`pivot`**][pivot]**`(`**`inward: `[`Boolean`][Boolean]**` = true) { `**`pivotColumns: `[`PivotColumnsSelector`][PivotColumnsSelector]**` }`**
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

` = true) { ` should likely be ` = true) { `

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

remember the surrounding-space-trim rule

*
* ### Reduce [Pivot] into [DataRow]
*
* [Pivot][Pivot]`.`[**`minBy`**][Pivot.minBy]**` { `**`column: `[`RowExpression`][RowExpression]**` }`**
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

` { ` is correct. Will be trimmed to <space>{<space>
**` }`** has one space too many at the start. It will not be trimmed since it doesn't start ánd end with a space

*
* ### Aggregate [Pivot] into [DataRow]
*
* [Pivot][Pivot]`.`[**`count`**][Pivot.count]**`() `**
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

useless space after ()

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

same below

* `| `__`.`__[**`groupByOther`**][Pivot.groupByOther]**`()`**
*
* {@include [Indent]}
* ` \[ `__`.`__[**`default`**][PivotGroupBy.default]**`(`**`defaultValue`**`) `**`]`
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

how did you want this to render? The spaces at the start disappear in KDoc atm. If you wanted more indent, @include [DoubleIndent] :) but I don't think indent is needed here

Copy link
Collaborator

@Jolanrensen Jolanrensen left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'll review more tomorrow :)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Add pivot KDocs

3 participants