docs: add @example blocks and flesh out sparse JSDoc#19
Merged
Conversation
Adds @example to public functions and methods that lacked them across greg, hdateBase, dateFormat, pad, gematriya, locale, hebrewStripNikkud, and HDate.add so the generated TypeDoc reference is self-explanatory. Also fills in descriptions that were missing or unhelpful: - getYahrzeitHD and getBirthdayHD had no JSDoc at all - hd2abs description was a copy of hebrew2abs; now explains the wrapper - AnniversaryDate type now documents its three accepted forms - isoDateString, Locale.addTranslations, and Locale.copyLocaleNoNikud expanded beyond their one-line stubs Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
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
1 participant
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.
Summary
@exampleblocks to public functions and methods acrossgreg,hdateBase,dateFormat,pad,gematriya,locale,hebrewStripNikkud, andHDate.addso the TypeDoc reference at https://hebcal.github.io/api/hdate/ shows runnable usage for each entry point.getYahrzeitHDandgetBirthdayHDhad no JSDoc at allhd2absdescription was a verbatim copy ofhebrew2abs; now explains it as theSimpleHebrewDatewrapperAnniversaryDatetype now documents its three accepted formsisoDateString,Locale.addTranslations, andLocale.copyLocaleNoNikudexpanded beyond their one-line stubsNo runtime behavior changes — comment-only edits.
Test plan
🤖 Generated with Claude Code