Skip to content

docs: add inline comments to script.js for new contributors#55

Merged
komalharshita merged 2 commits into
komalharshita:mainfrom
harshithab371:docs/add-inline-comments-script-js
May 16, 2026
Merged

docs: add inline comments to script.js for new contributors#55
komalharshita merged 2 commits into
komalharshita:mainfrom
harshithab371:docs/add-inline-comments-script-js

Conversation

@harshithab371
Copy link
Copy Markdown
Contributor

Fixes #54

What does this PR do?

Adds inline comments throughout static/script.js
to help new contributors understand the code.

Changes made

  • Added comments above every function explaining its purpose
  • Added inline comments on complex lines like isDuplicate,
    truncate, stopPropagation, fallbackCopy
  • No logic was changed — documentation only

Files changed

  • static/script.js

@vercel
Copy link
Copy Markdown

vercel Bot commented May 14, 2026

@harshithab371 is attempting to deploy a commit to the komalsony234-1530's projects Team on Vercel.

A member of the Team first needs to authorize it.

@harshithab371
Copy link
Copy Markdown
Contributor Author

"Hey! I've raised a PR for this issue. Please review when you get a chance "

@github-actions github-actions Bot added type:docs Improvements or additions to documentation gssoc-26 labels May 14, 2026
Copy link
Copy Markdown
Owner

@komalharshita komalharshita left a comment

Choose a reason for hiding this comment

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

Thanks for the contribution. The inline comments and onboarding-focused documentation improvements are helpful for new contributors.

However, this PR currently has merge conflicts because static/script.js has changed significantly in recent merged PRs. Please pull the latest main branch, resolve the conflicts locally, and update the PR against the newest version of the file before review can continue.

Since the script structure has evolved, please also verify that all comments still match the latest implementation accurately after rebasing.

@harshithab371
Copy link
Copy Markdown
Contributor Author

"Thanks for the review! I'll pull the latest main, resolve the conflicts, and verify all inline comments match the updated implementation. Will update the PR shortly."

@harshithab371
Copy link
Copy Markdown
Contributor Author

Resolved merge conflicts by merging latest upstream/main into the branch. Updated all inline comments to match the new script.js implementation accurately.
Ready for re-review!

@harshithab371 harshithab371 changed the title docs: add inline comments to script.js for new contributors feat: add ArFrame.to_numpy for numeric frames May 15, 2026
@harshithab371 harshithab371 changed the title feat: add ArFrame.to_numpy for numeric frames docs: add inline comments to script.js for new contributors May 15, 2026
Copy link
Copy Markdown
Owner

@komalharshita komalharshita left a comment

Choose a reason for hiding this comment

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

Thank you for addressing the requested changes and rebasing the PR against the latest main branch.

The updated inline comments are much better aligned with the current implementation and genuinely improve readability for new contributors onboarding into the project.

I especially appreciate that the comments focus on:

  • accessibility behaviour,
  • clipboard fallbacks,
  • state synchronization,
  • and UI interaction reasoning.

The PR now stays well-scoped to documentation improvements without introducing logic changes.

Nice work :)

@komalharshita komalharshita merged commit 046958c into komalharshita:main May 16, 2026
7 of 8 checks passed
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.

Add inline comments to script.js for new contributors

2 participants