Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

fix: Switch back function descriptions #72

Merged
merged 7 commits into from
Dec 14, 2023

Conversation

VebjornG
Copy link
Contributor

@VebjornG VebjornG commented Dec 12, 2023

Description

The function descriptions of Linear weighted moving average and Simple moving average had switched the places, so this bugfix places them where they belong.
Jira ticket

Motivation and Context

Functions in InDSL should have correct descriptions.

How Has This Been Tested?

Screenshots (if appropriate):

Types of changes

  • Bug fix (non-breaking change which fixes an issue)
  • Refactor (non-breaking change which improves implementation)
  • Performance (non-breaking change which improves performance. Please add associated performance test and results)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to change)
  • Non-functional change (xml comments/documentation/etc)

Contributor Checklist:

  • My code follows the code style of this project.
  • I have added an example of my new feature and included it in the documentation.
  • My change requires a change to the documentation.
  • I have updated the documentation accordingly.
  • I have read the CONTRIBUTING document.
  • I have added tests to cover my changes.
  • All new and existing tests passed.
  • My Pull Request name follows the naming convention fix: <description>, feat: <description>, etc.

Reviewer Checklist for Charts compliant functions:

  • The docstrings of the new function follow the contributing guidelines.
  • The new function is professionally documented
  • The new function and associated scripts are covered by one or more unit tests and code coverage did not decrease.
  • The new function is accompanied by an example and it is included in the Gallery of Charts.
  • The new function is reviewed in Chromatic. Access the storybook build results url and comment, approve or deny.
  • All function inputs, arguments, and outputs have a supported data type and have human readable names.
  • No code language is included in the description of the function or parameters (e.g use "polynomial order" instead of "poly_order")

@VebjornG VebjornG requested review from a team and redzaroslii December 12, 2023 13:13
Copy link

github-actions bot commented Dec 12, 2023

Unit Test Results

       21 files  ±0         21 suites  ±0   55m 34s ⏱️ - 1m 36s
  1 090 tests ±0    1 090 ✔️ ±0  0 💤 ±0  0 ±0 
15 402 runs  ±0  15 393 ✔️ ±0  9 💤 ±0  0 ±0 

Results for commit 1259f0a. ± Comparison against base commit 8475317.

♻️ This comment has been updated with latest results.

Copy link

codecov bot commented Dec 12, 2023

Codecov Report

Merging #72 (1259f0a) into main (8475317) will not change coverage.
The diff coverage is n/a.

Additional details and impacted files
@@           Coverage Diff           @@
##             main      #72   +/-   ##
=======================================
  Coverage   91.22%   91.22%           
=======================================
  Files         103      103           
  Lines        3770     3770           
  Branches      815      815           
=======================================
  Hits         3439     3439           
  Misses        207      207           
  Partials      124      124           

@VebjornG VebjornG requested a review from dbrattli December 12, 2023 13:35
Copy link
Contributor

@neringaalt neringaalt left a comment

Choose a reason for hiding this comment

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

The documentation is auto generated, you should not need to change HTML for it.
The mistake is in the rst file where you specify how to generate documentation.
Look at docs-source/source/smooth.rst, there you can see that wrong names are defined.

This is described here https://indsl.docs.cognite.com/contribute.html#document-your-algorithm

@neringaalt
Copy link
Contributor

Please add the Jira ticket as well

@neringaalt neringaalt requested review from lprovensi and removed request for lprovensi December 12, 2023 13:47
@VebjornG VebjornG requested a review from neringaalt December 12, 2023 15:52
Copy link
Contributor

@dbrattli dbrattli left a comment

Choose a reason for hiding this comment

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

LGTM

@dbrattli dbrattli self-requested a review December 13, 2023 15:26
@neringaalt neringaalt added the auto-merge Bulldozer auto-merge label Dec 14, 2023
@cognite-bulldozer cognite-bulldozer bot merged commit 8af4cea into main Dec 14, 2023
@cognite-bulldozer cognite-bulldozer bot deleted the vebjorn/fix-switched-desc branch December 14, 2023 13:00
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
auto-merge Bulldozer auto-merge
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants