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

chore: updated jsdoc for label-only slot #4607

Merged
merged 2 commits into from
Jul 23, 2024
Merged

Conversation

Rajdeepc
Copy link
Contributor

Description

Also fix some typos in comments. Without this change the linter complains about use of label-only slot.

Related issue(s)

Motivation and context

How has this been tested?

  • Test case 1
    1. Go here
    2. Do this
  • Test case 2
    1. Go here
    2. Do this

Screenshots (if appropriate)

Types of changes

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to change)
  • Chore (minor updates related to the tooling or maintenance of the repository, does not impact compiled assets)

Checklist

  • I have signed the Adobe Open Source CLA.
  • My code follows the code style of this project.
  • If my change required a change to the documentation, I have updated the documentation in this pull request.
  • I have read the CONTRIBUTING document.
  • I have added tests to cover my changes.
  • All new and existing tests passed.
  • I have reviewed at the Accessibility Practices for this feature, see: Aria Practices

Best practices

This repository uses conventional commit syntax for each commit message; note that the GitHub UI does not use this by default so be cautious when accepting suggested changes. Avoid the "Update branch" button on the pull request and opt instead for rebasing your branch against main.

Copy link

Branch preview

Visual regression test results

When a visual regression test fails (or has previously failed while working on this branch), its results can be found in the following URLs:

Copy link

github-actions bot commented Jul 18, 2024

Lighthouse scores

Category Latest (report) Main (report) Branch (report)
Performance 0.99 0.99 0.99
Accessibility 1 1 1
Best Practices 1 1 1
SEO 1 0.92 0.92
PWA 1 1 1
What is this?

Lighthouse scores comparing the documentation site built from the PR ("Branch") to that of the production documentation site ("Latest") and the build currently on main ("Main"). Higher scores are better, but note that the SEO scores on Netlify URLs are artifically constrained to 0.92.

Transfer Size

Category Latest Main Branch
Total 224.797 kB 212.221 kB 211.891 kB 🏆
Scripts 56.623 kB 49.787 kB 49.539 kB 🏆
Stylesheet 35.246 kB 30.454 kB 30.393 kB 🏆
Document 6.134 kB 5.338 kB 5.335 kB 🏆
Font 126.794 kB 126.642 kB 126.624 kB 🏆

Request Count

Category Latest Main Branch
Total 48 48 48
Scripts 40 40 40
Stylesheet 5 5 5
Document 1 1 1
Font 2 2 2

Copy link

github-actions bot commented Jul 18, 2024

Tachometer results

Chrome

action-menu permalink

test-basic

Version Bytes Avg Time vs remote vs branch
npm latest 647 kB 132.57ms - 135.49ms - faster ✔
4% - 7%
6.06ms - 10.12ms
branch 634 kB 140.71ms - 143.53ms slower ❌
4% - 8%
6.06ms - 10.12ms
-

test-directive permalink

Version Bytes Avg Time vs remote vs branch
npm latest 605 kB 61.71ms - 63.15ms - faster ✔
3% - 9%
2.22ms - 5.79ms
branch 592 kB 64.80ms - 68.07ms slower ❌
4% - 9%
2.22ms - 5.79ms
-

test-lazy permalink

Version Bytes Avg Time vs remote vs branch
npm latest 604 kB 59.64ms - 60.69ms - faster ✔
5% - 9%
3.49ms - 5.57ms
branch 591 kB 63.80ms - 65.59ms slower ❌
6% - 9%
3.49ms - 5.57ms
-

test-open-close-directive permalink

Version Bytes Avg Time vs remote vs branch
npm latest 791 kB 1874.86ms - 1877.94ms - unsure 🔍
-0% - +0%
-0.88ms - +3.49ms
branch 777 kB 1873.54ms - 1876.64ms unsure 🔍
-0% - +0%
-3.49ms - +0.88ms
-

test-open-close permalink

Version Bytes Avg Time vs remote vs branch
npm latest 789 kB 1861.77ms - 1864.71ms - unsure 🔍
-0% - +0%
-1.99ms - +2.47ms
branch 776 kB 1861.33ms - 1864.68ms unsure 🔍
-0% - +0%
-2.47ms - +1.99ms
-
Firefox

action-menu permalink

test-basic

Version Bytes Avg Time vs remote vs branch
npm latest 647 kB 270.23ms - 272.97ms - faster ✔
16% - 17%
50.77ms - 56.23ms
branch 634 kB 322.74ms - 327.46ms slower ❌
19% - 21%
50.77ms - 56.23ms
-

test-directive permalink

Version Bytes Avg Time vs remote vs branch
npm latest 605 kB 127.46ms - 131.62ms - unsure 🔍
-3% - +1%
-3.85ms - +1.13ms
branch 592 kB 129.54ms - 132.26ms unsure 🔍
-1% - +3%
-1.13ms - +3.85ms
-

test-lazy permalink

Version Bytes Avg Time vs remote vs branch
npm latest 604 kB 163.28ms - 168.36ms - slower ❌
11% - 18%
16.62ms - 25.14ms
branch 591 kB 141.52ms - 148.36ms faster ✔
10% - 15%
16.62ms - 25.14ms
-

test-open-close-directive permalink

Version Bytes Avg Time vs remote vs branch
npm latest 791 kB 1903.82ms - 1915.38ms - slower ❌
1% - 2%
18.68ms - 30.96ms
branch 777 kB 1882.72ms - 1886.84ms faster ✔
1% - 2%
18.68ms - 30.96ms
-

test-open-close permalink

Version Bytes Avg Time vs remote vs branch
npm latest 789 kB 1882.00ms - 1888.40ms - unsure 🔍
-0% - +0%
-5.74ms - +3.74ms
branch 776 kB 1882.70ms - 1889.70ms unsure 🔍
-0% - +0%
-3.74ms - +5.74ms
-

@Rajdeepc Rajdeepc requested a review from a team July 18, 2024 08:44
@Rajdeepc Rajdeepc merged commit ec30b7f into main Jul 23, 2024
58 checks passed
@Rajdeepc Rajdeepc deleted the kingswayer/jsdoc-changes branch July 23, 2024 11:54
Rajdeepc added a commit that referenced this pull request Aug 2, 2024
Co-authored-by: Rajdeep Chandra <rajdeepchandra@rajdeeps-mbp-2.macromedia.com>
Rajdeepc added a commit that referenced this pull request Aug 2, 2024
Co-authored-by: Rajdeep Chandra <rajdeepchandra@rajdeeps-mbp-2.macromedia.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant