Update docs for some operators #585
Conversation
![ellipsis-dev[bot]](https://avatars.githubusercontent.com/in/64358?s=60&v=4){kind=small}
There was a problem hiding this comment.
👍 Looks good to me! Reviewed everything up to 2f9b0b0 in 24 seconds
More details
- Looked at
218lines of code in6files - Skipped
0files when reviewing. - Skipped posting
2drafted comments based on config settings.
1. docs/pages/api-reference/aggregations/max.md:27
- Draft comment:
Thedefaultparameter should includedateanddatetimein its type to match theofparameter.
<Expandable title="default" type="Union[int, float, date, datetime]">
- Reason this comment was not posted:
Comment was on unchanged code.
2. docs/pages/api-reference/aggregations/min.md:27
- Draft comment:
Thedefaultparameter should includedateanddatetimein its type to match theofparameter.
<Expandable title="default" type="Union[int, float, date, datetime]">
- Reason this comment was not posted:
Comment was on unchanged code.
Workflow ID: wflow_A54YuJp5lUxNYlHT
You can customize Ellipsis with 👍 / 👎 feedback, review rules, user-specific overrides, quiet mode, and more.
| Operator to convert a keyed dataset into a keyless one, where the underlying delta | ||
| frame of the dataset is presented as a changelog. All key fields are converted into | ||
| normal fields, and an additional column is added which contains the kind (insert | ||
| or delete) of the delta. |
There was a problem hiding this comment.
users dont know about delta frame ( an internal detail ),
Operator to convert a keyed dataset into a CDC changelog stream. All key fields are converted into value fields, and an additional column is added, indicating the type of change (insert or delete) for the delta.
There was a problem hiding this comment.
Python users don't know about value fields either
| #### Returns | ||
|
|
||
| <Expandable type="Dataset"> | ||
| Returns a dataset with underlying delta frame of the input dataset is presented as |
There was a problem hiding this comment.
fix this accordingly
There was a problem hiding this comment.
❌ Changes requested. Incremental review on 69a57d7 in 15 seconds
More details
- Looked at
58lines of code in3files - Skipped
0files when reviewing. - Skipped posting
0drafted comments based on config settings.
Workflow ID: wflow_F2vOl02fnkiVRuxY
Want Ellipsis to fix these issues? Tag @ellipsis-dev in a comment. You can customize Ellipsis with 👍 / 👎 feedback, review rules, user-specific overrides, quiet mode, and more.
| <Expandable type="Dataset"> | ||
| Returns a dataset with input keyed dataset into an append only CDC changelog | ||
| stream. All key fields converted into normal fields, and an additional | ||
| column is addedm which contains the type of change (insert or delete) for the |
There was a problem hiding this comment.
Typo: Replace 'addedm' with 'added'.
| column is addedm which contains the type of change (insert or delete) for the | |
| column is added, which contains the type of change (insert or delete) for the |
There was a problem hiding this comment.
👍 Looks good to me! Incremental review on dc5162a in 9 seconds
More details
- Looked at
13lines of code in1files - Skipped
0files when reviewing. - Skipped posting
1drafted comments based on config settings.
1. docs/pages/api-reference/operators/changelog.md:28
- Draft comment:
Consider rephrasing for clarity: "Returns a dataset with the input keyed dataset converted into an append-only CDC changelog stream. All key fields are converted into normal fields, and an additional column is added, which contains the type of change (insert or delete) for the delta." - Reason this comment was not posted:
Confidence changes required:50%
The documentation is mostly clear, but there are some minor grammatical issues and a potential for confusion in the description of the parameters.
Workflow ID: wflow_3AVyuZmxbEA21mMj
You can customize Ellipsis with 👍 / 👎 feedback, review rules, user-specific overrides, quiet mode, and more.
satrana42
force-pushed
the
sat/update_docs
branch
from
dc5162a
to
d638ccb
Compare
There was a problem hiding this comment.
👍 Looks good to me! Incremental review on d638ccb in 7 seconds
More details
- Looked at
13lines of code in1files - Skipped
0files when reviewing. - Skipped posting
1drafted comments based on config settings.
1. docs/pages/api-reference/operators/changelog.md:28
- Draft comment:
Minor grammatical error. Consider rephrasing for clarity. - Reason this comment was not posted:
Confidence changes required:10%
The documentation for thechangelogoperator is mostly clear, but there is a minor grammatical error in the description of theReturnssection.
Workflow ID: wflow_nFmIwBcR7bAF42Bn
You can customize Ellipsis with 👍 / 👎 feedback, review rules, user-specific overrides, quiet mode, and more.
There was a problem hiding this comment.
👍 Looks good to me! Incremental review on b601ac1 in 15 seconds
More details
- Looked at
12lines of code in1files - Skipped
0files when reviewing. - Skipped posting
1drafted comments based on config settings.
1. .wordlist.txt:23
- Draft comment:
The addition of 'changelog' seems redundant as 'Changelog' is already present. Consider removing one to maintain consistency. - Reason this comment was not posted:
Decided after close inspection that this draft comment was likely wrong and/or not actionable:
The wordlist includes both capitalized and lowercase versions of words, suggesting that this might be intentional to account for case sensitivity in different contexts. The comment points out a potential redundancy, but without knowing the specific use case for the wordlist, it's speculative to assume that one should be removed. The presence of both forms might be necessary for the application's functionality.
I might be missing the specific context or requirements for the wordlist, which could justify having both 'Changelog' and 'changelog'. The comment assumes redundancy without strong evidence that it is an issue.
Even without specific context, the pattern in the wordlist suggests that both forms are intentionally included. The comment lacks strong evidence that this is an issue that needs addressing.
The comment should be deleted because it speculates on redundancy without strong evidence, and the pattern in the wordlist suggests intentional inclusion of both forms.
Workflow ID: wflow_eNbe93k0yNm3JUGL
You can customize Ellipsis with 👍 / 👎 feedback, review rules, user-specific overrides, quiet mode, and more.
In this change, we update or add documentation for operator
changes done in #553, #556, #535, #560 and #578.
Important
Update documentation for
firstk,max,min,changelog, andjoinoperators with new parameters and type clarifications.firstk.md: Adddropnullparameter to dropNonevalues.max.mdandmin.md: Updateofandinto_fieldtypes to includedateanddatetime.changelog.md: New file added forChangelogoperator documentation.join.md: Addfieldsparameter to specify right dataset fields in output.This description was created by
for b601ac1. It will automatically update as commits are pushed.