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

Update API Readme to indicate renderWhenVisible function is optional #7285

Conversation

scottbell
Copy link
Contributor

@scottbell scottbell commented Dec 7, 2023

Closes #7284

Describe your changes:

Updated API documentation to indicate renderWhenVisible function is optional

All Submissions:

  • Have you followed the guidelines in our Contributing document?
  • Have you checked to ensure there aren't other open Pull Requests for the same update/change?
  • Is this change backwards compatible? For example, developers won't need to change how they are calling the API or how they've extended core plugins such as Tables or Plots.

Author Checklist

  • Changes address original issue?
  • Tests included and/or updated with changes?
  • Command line build passes?
  • Has this been smoke tested?
  • Testing instructions included in associated issue OR is this a dependency/testcase change?

Reviewer Checklist

  • Changes appear to address issue?
  • Reviewer has tested changes by following the provided instructions?
  • Changes appear not to be breaking changes?
  • Appropriate automated tests included?
  • Code style and in-line documentation are appropriate?
  • Has associated issue been labelled unverified? (only applicable if this PR closes the issue)
  • Has associated issue been labelled bug? (only applicable if this PR is for a bug fix)

Copy link

deploysentinel bot commented Dec 7, 2023

Current Playwright Test Results Summary

✅ 15 Passing

Run may still be in progress, this comment will be updated as current testing workflow or job completes...

(Last updated on 12/13/2023 09:57:38am UTC)

Run Details

Running Workflow e2e-couchdb on Github Actions

Commit: e6aac77

Started: 12/13/2023 09:55:55am UTC

View Detailed Build Results


Current Playwright Test Results Summary

✅ 164 Passing - ⚠️ 4 Flaky

Run may still be in progress, this comment will be updated as current testing workflow or job completes...

(Last updated on 12/13/2023 09:57:38am UTC)

Run Details

Running Job e2e-stable on CircleCI

Commit: e6aac77

Started: 12/12/2023 10:10:43pm UTC

⚠️ Flakes

📄   functional/planning/ganttChart.e2e.spec.js • 1 Flake

Test Case Results

Test Case Last 7 days Failures Last 7 days Flakes
Gantt Chart Replaces a plan with a new plan
Retry 1Initial Attempt
0% (0) 0 / 49 runs
failed over last 7 days
2.04% (1) 1 / 49 run
flaked over last 7 days

📄   functional/planning/timelist.e2e.spec.js • 1 Flake

Test Case Results

Test Case Last 7 days Failures Last 7 days Flakes
Time List Create a Time List, add a single Plan to it and verify all the activities are displayed with no milliseconds
Retry 1Initial Attempt
8.16% (4) 4 / 49 runs
failed over last 7 days
69.39% (34) 34 / 49 runs
flaked over last 7 days

📄   functional/plugins/notebook/restrictedNotebook.e2e.spec.js • 1 Flake

Test Case Results

Test Case Last 7 days Failures Last 7 days Flakes
Restricted Notebook with a page locked and with an embed @addinit Allows embeds to be deleted if page unlocked @addinit
Retry 1Initial Attempt
0% (0) 0 / 25 runs
failed over last 7 days
60% (15) 15 / 25 runs
flaked over last 7 days

📄   functional/plugins/notebook/notebookSnapshots.e2e.spec.js • 1 Flake

Test Case Results

Test Case Last 7 days Failures Last 7 days Flakes
Snapshot image tests Can drop an image onto a notebook and create a new entry
Retry 1Initial Attempt
0% (0) 0 / 25 runs
failed over last 7 days
48% (12) 12 / 25 runs
flaked over last 7 days

View Detailed Build Results


Copy link

codecov bot commented Dec 7, 2023

Codecov Report

Merging #7285 (e6aac77) into master (9ed8d4f) will increase coverage by 0.79%.
The diff coverage is n/a.

Additional details and impacted files
@@            Coverage Diff             @@
##           master    #7285      +/-   ##
==========================================
+ Coverage   55.10%   55.90%   +0.79%     
==========================================
  Files         655      655              
  Lines       26297    26297              
  Branches     2541     2541              
==========================================
+ Hits        14492    14701     +209     
+ Misses      11103    10888     -215     
- Partials      702      708       +6     
Flag Coverage Δ *Carryforward flag
e2e-full 41.85% <ø> (-0.06%) ⬇️ Carriedforward from 34cb992
e2e-stable 58.32% <ø> (+3.49%) ⬆️
unit 49.21% <ø> (-0.07%) ⬇️

*This pull request uses carry forward flags. Click here to find out more.

see 53 files with indirect coverage changes


Continue to review full report in Codecov by Sentry.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 9ed8d4f...e6aac77. Read the comment docs.

@ozyx ozyx added the type:docs updates to documentation label Dec 8, 2023
@ozyx ozyx added this to the Target:3.3.0 milestone Dec 12, 2023
Copy link
Contributor

@akhenry akhenry left a comment

Choose a reason for hiding this comment

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

LGTM

…erwhenvisible-is-required-it-should-be-optional
@akhenry akhenry enabled auto-merge (squash) December 12, 2023 22:08
@scottbell scottbell added the pr:e2e:couchdb npm run test:e2e:couchdb label Dec 13, 2023
@github-actions github-actions bot removed the pr:e2e:couchdb npm run test:e2e:couchdb label Dec 13, 2023
@akhenry akhenry merged commit 902ed02 into master Dec 13, 2023
@akhenry akhenry deleted the 7284-api-documentation-indicates-that-renderwhenvisible-is-required-it-should-be-optional branch December 13, 2023 09:57
@unlikelyzero unlikelyzero modified the milestones: Target:3.3.0, Target:4.0.0 Feb 1, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
type:docs updates to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

API documentation indicates that renderWhenVisible is required, it should be optional
4 participants