Skip to content

Update API docs links and update code examples to use ES6 syntax#66

Open
n-older wants to merge 2 commits into
masterfrom
update-api-docs-link
Open

Update API docs links and update code examples to use ES6 syntax#66
n-older wants to merge 2 commits into
masterfrom
update-api-docs-link

Conversation

@n-older
Copy link
Copy Markdown
Contributor

@n-older n-older commented May 13, 2026

  • Update API docs links to match query param format used by new docs to set preferred programming language
  • Update code examples to use ES6 syntax

Copilot AI review requested due to automatic review settings May 13, 2026 18:45
jclusso
jclusso previously approved these changes May 13, 2026
Copy link
Copy Markdown

Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull request overview

This PR updates the README documentation links for the new API docs language query parameter and modernizes JavaScript examples toward ES6-style syntax.

Changes:

  • Updated API documentation URLs to the /docs/api/emails/ path with code_language=javascript.
  • Replaced several callback examples with arrow functions.
  • Updated sample declarations from var to const and adjusted example formatting.
Comments suppressed due to low confidence (3)

README.md:51

  • The request-time authentication examples omit the required email argument. verify takes the email as the first parameter and authentication options as the second, so copied code would send the auth object as the email value and would not apply the per-request credential.
emailable.verify({ apiKey: 'YOUR_API_KEY' })

// set access_token at request time
emailable.verify({ accessToken: 'YOUR_API_KEY' })

README.md:51

  • This access-token example still uses an API-key placeholder. Readers trying to authenticate with an access token may copy the wrong credential type; the placeholder should distinguish an access token from an API key.
emailable.verify({ accessToken: 'YOUR_API_KEY' })

README.md:103

  • The standalone ... makes this fenced JavaScript example invalid syntax. Since this is presented as an ES6 code example, use concrete sample addresses or move the ellipsis into prose/comment text so the snippet remains copy-pastable.
const emails = ['jarrett@emailable.com', 'support@emailable.com', ...];

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Comment thread README.md Outdated
Comment thread README.md Outdated
Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>
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.

3 participants