Skip to content

docs(deploy): add JSDoc to obfuscateGitPass, exec, escapeArg, and hasGit#11901

Open
yahyanaujid wants to merge 1 commit intofacebook:mainfrom
yahyanaujid:patch-1
Open

docs(deploy): add JSDoc to obfuscateGitPass, exec, escapeArg, and hasGit#11901
yahyanaujid wants to merge 1 commit intofacebook:mainfrom
yahyanaujid:patch-1

Conversation

@yahyanaujid
Copy link
Copy Markdown

Motivation

The internal utility functions in deploy.ts lacked JSDoc documentation,
making it harder for new contributors to understand their purpose and parameters.

Changes

  • Added JSDoc to obfuscateGitPass
  • Added JSDoc to exec with full @param descriptions
  • Added JSDoc to escapeArg explaining why manual escaping is needed
  • Added JSDoc to hasGit

Added documentation comments for functions to improve code clarity and maintainability.
@meta-cla meta-cla bot added the CLA Signed Signed Facebook CLA label Apr 4, 2026
@netlify
Copy link
Copy Markdown

netlify bot commented Apr 4, 2026

[V2]

Built without sensitive environment variables

Name Link
🔨 Latest commit a8c97cb
🔍 Latest deploy log https://app.netlify.com/projects/docusaurus-2/deploys/69d0bc4a7546910008a55b7e
😎 Deploy Preview https://deploy-preview-11901--docusaurus-2.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify project configuration.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

CLA Signed Signed Facebook CLA

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant