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 documentation for Visibility-Based Rendering #7262

Conversation

scottbell
Copy link
Contributor

@scottbell scottbell commented Nov 30, 2023

Closes #7259

Describe your changes:

Update API documentation for Visibility-Based Rendering

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 Nov 30, 2023

Current Playwright Test Results Summary

✅ 162 Passing - ⚠️ 5 Flaky

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

(Last updated on 11/30/2023 08:35:38am UTC)

Run Details

Running Job e2e-stable on CircleCI

Commit: f9d4531

Started: 11/30/2023 08:28:53am UTC

⚠️ Flakes

📄   functional/plugins/telemetryTable/telemetryTable.e2e.spec.js • 1 Flake

Test Case Results

Test Case Last 7 days Failures Last 7 days Flakes
Telemetry Table unpauses and filters data when paused by button and user changes bounds
Retry 1Initial Attempt
0% (0) 0 / 19 runs
failed over last 7 days
31.58% (6) 6 / 19 runs
flaked over last 7 days

📄   functional/plugins/flexibleLayout/flexibleLayout.e2e.spec.js • 1 Flake

Test Case Results

Test Case Last 7 days Failures Last 7 days Flakes
Flexible Layout items in a flexible layout can be removed with object tree context menu when viewing another item
Retry 1Initial Attempt
0% (0) 0 / 19 runs
failed over last 7 days
5.26% (1) 1 / 19 run
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 Disallows embeds to be deleted if page locked @addinit
Retry 1Initial Attempt
0% (0) 0 / 19 runs
failed over last 7 days
26.32% (5) 5 / 19 runs
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
6.98% (3) 3 / 43 runs
failed over last 7 days
46.51% (20) 20 / 43 runs
flaked over last 7 days

📄   functional/plugins/imagery/exampleImagery.e2e.spec.js • 1 Flake

Test Case Results

Test Case Last 7 days Failures Last 7 days Flakes
Example Imagery Object Can use Mouse Wheel to zoom in and out of latest image
Retry 1Initial Attempt
0% (0) 0 / 19 runs
failed over last 7 days
26.32% (5) 5 / 19 runs
flaked over last 7 days

View Detailed Build Results


Current Playwright Test Results Summary

✅ 14 Passing

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

(Last updated on 11/30/2023 08:35:38am UTC)

Run Details

Running Workflow e2e-couchdb on Github Actions

Commit: f9d4531

Started: 11/30/2023 08:29:03am UTC

View Detailed Build Results


Copy link

codecov bot commented Nov 30, 2023

Codecov Report

Merging #7262 (f9d4531) into master (97cb783) will increase coverage by 0.03%.
The diff coverage is n/a.

Additional details and impacted files
@@            Coverage Diff             @@
##           master    #7262      +/-   ##
==========================================
+ Coverage   56.04%   56.08%   +0.03%     
==========================================
  Files         654      654              
  Lines       26229    26229              
  Branches     2528     2528              
==========================================
+ Hits        14701    14711      +10     
+ Misses      10828    10818      -10     
  Partials      700      700              
Flag Coverage Δ
e2e-full 41.88% <ø> (ø)
e2e-stable 58.41% <ø> (+0.07%) ⬆️
unit 49.34% <ø> (-0.01%) ⬇️

see 5 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 97cb783...f9d4531. Read the comment docs.

Copy link
Collaborator

@unlikelyzero unlikelyzero left a comment

Choose a reason for hiding this comment

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

We will need to cherrypick this back onto 3.2.0

@scottbell scottbell merged commit 41bee31 into master Dec 1, 2023
13 of 22 checks passed
@scottbell scottbell deleted the 7259-update-view-api-documentation-with-new-visibility-functionality branch December 1, 2023 09:35
scottbell added a commit that referenced this pull request Dec 1, 2023
update API with documentation for Visibility-Based Rendering
@scottbell
Copy link
Contributor Author

We will need to cherrypick this back onto 3.2.0

@unlikelyzero #7267

unlikelyzero pushed a commit that referenced this pull request Dec 1, 2023
…dering (#7267)

Update API documentation for Visibility-Based Rendering (#7262)

update API with documentation for Visibility-Based Rendering
@unlikelyzero unlikelyzero added this to the Target:3.3.0 milestone Dec 4, 2023
@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
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Update View API documentation with new visibility functionality
2 participants