docs: document the language-tagged string use case#91
Draft
jeswr wants to merge 1 commit into
Draft
Conversation
Adds a 'Language-tagged strings' subsection to the README under 'Wrapping Terms', showing how to map rdf:langString literals with LiteralAs.langString/LiteralFrom.langString, the langTuple variants, and Mapping.languageDictionary for one-value-per-language properties. Also adds dense JSDoc (@remarks, @throws, titled @example blocks pairing turtle with a mapping class, @see) to LiteralAs.langString and LiteralAs.langTuple, matching the style of LiteralAs.uInt8Array. No behaviour change. Closes rdfjs#75 Co-Authored-By: Claude Fable 5 <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
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.
Documents the language-tagged string (
rdf:langString) use case. Support already exists (ILangString,LiteralAs.langString/langTuple,LiteralFrom.langString/langTuple,Mapping.languageDictionary) and is covered by the existing test suite — this PR only adds the missing documentation. No behaviour change.Closes #75
What it does
"The librarian"@en) and a getter/setter mapping class usingLiteralAs.langString/LiteralFrom.langString({lang, string}objects), with usage output;langTuple([language, value]) variants;Mapping.languageDictionaryexample wrapping a one-value-per-language predicate as a JavaScriptMap, with usage output.LiteralAs.langStringandLiteralAs.langTuple(summary,@remarks,@throws, titled@exampleblocks pairing turtle with a mapping class,@see), matching the style of the neighbouringLiteralAs.uInt8Arraydocs.Checks
npx typedocpasses; all new{@link}targets resolve (the only warnings are ones pre-existing onmain).npm testgreen (122 tests, 0 failures);npm audit --omit=dev --audit-level=moderateclean.