[DOCS-14604] Investigate changes in SERVER-57629: change $integral&$derivative argument from 'outputUnit' to 'unit' Created: 28/Jun/21  Updated: 13/Nov/23  Resolved: 29/Jun/21

Status: Closed
Project: Documentation
Component/s: manual, Server
Affects Version/s: None
Fix Version/s: 5.0.0-rc5, Server_Docs_20231030, Server_Docs_20231106, Server_Docs_20231105, Server_Docs_20231113

Type: Task Priority: Major - P3
Reporter: Backlog - Core Eng Program Management Team Assignee: Jason Price
Resolution: Works as Designed Votes: 0
Labels: None
Remaining Estimate: Not Specified
Time Spent: Not Specified
Original Estimate: Not Specified

Issue Links:
Documented
documents SERVER-57629 change $integral&$derivative argument... Closed
Participants:
Days since reply: 2 years, 32 weeks, 2 days ago
Epic Link: DOCSP-9747

 Description   

Description

Downstream Change Summary

'outputUnit' argument of $integral and $derivative is now 'unit'

Description of Linked Ticket

In the $integral and the $derivative window functions, 'outputUnit' specifies how to express time deltas as a number. We originally called it 'outputUnit' to avoid a name collision with the 'unit' used for the window bounds.

This name is confusing though, because often the measurements implicitly have a unit involving time. For example, suppose you have numbers representing meters/second, and times represented as a datetime. The result will have units of meters, so writing outputUnit: 'second' is counterintuitive.

Now that the 'window' arguments are separate, we could go back to calling this argument just 'unit':

{$integral: {
   input: "$rate",
   unit: "second"
 },
 window: {
   range: [-1, 0],
   unit: "hour"
 }
}

Scope of changes

Impact to Other Docs

MVP (Work and Date)

Resources (Scope or Design Docs, Invision, etc.)


Generated at Thu Feb 08 08:10:46 UTC 2024 using Jira 9.7.1#970001-sha1:2222b88b221c4928ef0de3161136cc90c8356a66.