influxdata / influxdata/docs-v2

Derivative function in/out examples not matching reality

Open
#4,184 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Flux product:flux
Dominant language
JavaScript
Stars
82
Forks
326
Avg merge
1d 1h
Merged PRs (30d)
82

Description

The input and output examples don't match the reality for the derivative function.

##### Relevant URLs
https://docs.influxdata.com/flux/v0.x/stdlib/universe/derivative/

Screen Shot 2022-07-05 at 1 24 38 PM

Related to https://github.com/influxdata/flux/issues/4942

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start with the derivative documentation at https://docs.influxdata.com/flux/v0.x/stdlib/universe/derivative/ and compare its input and output examples with the function's actual behavior. Review the related issue, flux#4942, for context. Done means the documented examples accurately reflect the derivative function.

Written by the indexing model from the issue text.

Assessment

Domain
documentation
Issue type
Documentation
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.