Update API docs links and update code examples to use ES6 syntax#66
Open
n-older wants to merge 2 commits into
Open
Update API docs links and update code examples to use ES6 syntax#66n-older wants to merge 2 commits into
n-older wants to merge 2 commits into
Conversation
Contributor
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
jclusso
previously approved these changes
May 13, 2026
There was a problem hiding this comment.
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 withcode_language=javascript. - Replaced several callback examples with arrow functions.
- Updated sample declarations from
vartoconstand adjusted example formatting.
Comments suppressed due to low confidence (3)
README.md:51
- The request-time authentication examples omit the required email argument.
verifytakes 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.
Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>
jclusso
approved these changes
May 13, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.