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

docs: Build docs #319

Merged
merged 2 commits into from
Sep 16, 2024
Merged

docs: Build docs #319

merged 2 commits into from
Sep 16, 2024

Conversation

neringaalt
Copy link
Contributor

@neringaalt neringaalt commented Sep 16, 2024

Description

Motivation and Context

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")

@neringaalt neringaalt requested review from a team and MortGron September 16, 2024 06:23
Copy link

codecov bot commented Sep 16, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 91.23%. Comparing base (396ddec) to head (63da43b).
Report is 1 commits behind head on main.

Additional details and impacted files
@@           Coverage Diff           @@
##             main     #319   +/-   ##
=======================================
  Coverage   91.23%   91.23%           
=======================================
  Files         109      109           
  Lines        3969     3969           
  Branches      858      858           
=======================================
  Hits         3621     3621           
  Misses        212      212           
  Partials      136      136           

@neringaalt neringaalt changed the title chore: Build docs docs: Build docs Sep 16, 2024
Copy link

Unit Test Results

    15 files  ±0      15 suites  ±0   27m 9s ⏱️ +40s
 1 130 tests ±0   1 130 ✅ ±0  0 💤 ±0  0 ❌ ±0 
11 163 runs  ±0  11 154 ✅ ±0  9 💤 ±0  0 ❌ ±0 

Results for commit 63da43b. ± Comparison against base commit 396ddec.

@neringaalt neringaalt merged commit 1a87492 into main Sep 16, 2024
37 checks passed
@neringaalt neringaalt deleted the build-docs branch September 16, 2024 08:48
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.

2 participants