Update documentation.

README.md

@@ -11,7 +11,8 @@ Its functionality falls in the following categories:
 - Arithmetic: addition, subtraction, multiplication, division, remainder and 
   exponentiation
 - Compliant with `DecimalFloatingPoint` and, optionally, `Real` protocols.
-- Support for complex decimal numbers via ` if `Real` protocol compliance is enabled.
+- Support for complex decimal numbers via `swift-numerics` if `Real` protocol 
+  compliance is enabled.
 - Constants: `pi`, `zero`, `one`, `ten`
 - Functions: exp, log, log10, log2, pow, sqrt, root, factorial, gamma, 
              trig + inverse, hyperbolic + inverse

Sources/BigDecimal/BigDecimal.docc/BigDecimal.doccarchive/data/documentation/bigdecimal/bigdecimal/hypot(_:_:).json

@@ -0,0 +1 @@
+{"primaryContentSections":[{"kind":"declarations","declarations":[{"tokens":[{"kind":"keyword","text":"static"},{"kind":"text","text":" "},{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"hypot"},{"kind":"text","text":"("},{"kind":"externalParam","text":"_"},{"kind":"text","text":" "},{"kind":"internalParam","text":"x"},{"kind":"text","text":": "},{"kind":"typeIdentifier","identifier":"doc:\/\/BigDecimal\/documentation\/BigDecimal\/BigDecimal","preciseIdentifier":"s:10BigDecimalAAV","text":"BigDecimal"},{"kind":"text","text":", "},{"kind":"externalParam","text":"_"},{"kind":"text","text":" "},{"kind":"internalParam","text":"y"},{"kind":"text","text":": "},{"kind":"typeIdentifier","identifier":"doc:\/\/BigDecimal\/documentation\/BigDecimal\/BigDecimal","preciseIdentifier":"s:10BigDecimalAAV","text":"BigDecimal"},{"kind":"text","text":") -> "},{"kind":"typeIdentifier","identifier":"doc:\/\/BigDecimal\/documentation\/BigDecimal\/BigDecimal","preciseIdentifier":"s:10BigDecimalAAV","text":"BigDecimal"}],"languages":["swift"],"platforms":["macOS"]}]}],"schemaVersion":{"major":0,"minor":3,"patch":0},"sections":[],"variants":[{"paths":["\/documentation\/bigdecimal\/bigdecimal\/hypot(_:_:)"],"traits":[{"interfaceLanguage":"swift"}]}],"identifier":{"url":"doc:\/\/BigDecimal\/documentation\/BigDecimal\/BigDecimal\/hypot(_:_:)","interfaceLanguage":"swift"},"kind":"symbol","metadata":{"role":"symbol","title":"hypot(_:_:)","roleHeading":"Type Method","fragments":[{"kind":"keyword","text":"static"},{"kind":"text","text":" "},{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"hypot"},{"kind":"text","text":"("},{"kind":"typeIdentifier","text":"BigDecimal","preciseIdentifier":"s:10BigDecimalAAV"},{"kind":"text","text":", "},{"kind":"typeIdentifier","text":"BigDecimal","preciseIdentifier":"s:10BigDecimalAAV"},{"kind":"text","text":") -> "},{"kind":"typeIdentifier","text":"BigDecimal","preciseIdentifier":"s:10BigDecimalAAV"}],"symbolKind":"method","externalID":"s:10BigDecimalAAV5hypotyA2B_ABtFZ","extendedModule":"BigDecimal","modules":[{"name":"BigDecimal"}]},"hierarchy":{"paths":[["doc:\/\/BigDecimal\/documentation\/BigDecimal","doc:\/\/BigDecimal\/documentation\/BigDecimal\/BigDecimal"]]},"references":{"doc://BigDecimal/documentation/BigDecimal/BigDecimal/exponent":{"role":"symbol","title":"exponent","fragments":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"kind":"identifier","text":"exponent"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"Int","preciseIdentifier":"s:Si"}],"abstract":[{"type":"text","text":"The signed exponent - the value of "},{"type":"emphasis","inlineContent":[{"type":"text","text":"self"}]},{"type":"text","text":" is "},{"type":"emphasis","inlineContent":[{"type":"text","text":"self.significand"}]},{"type":"text","text":" *"},{"type":"text","text":" "},{"type":"text","text":"10^"},{"type":"emphasis","inlineContent":[{"type":"text","text":"self.exponent"}]}],"identifier":"doc:\/\/BigDecimal\/documentation\/BigDecimal\/BigDecimal\/exponent","kind":"symbol","type":"topic","url":"\/documentation\/bigdecimal\/bigdecimal\/exponent"},"doc://BigDecimal/documentation/BigDecimal/BigDecimal/digits":{"role":"symbol","title":"digits","fragments":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"kind":"identifier","text":"digits"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"BInt","preciseIdentifier":"s:6BigInt4BIntV"}],"abstract":[{"type":"text","text":"The signed BInt significand"}],"identifier":"doc:\/\/BigDecimal\/documentation\/BigDecimal\/BigDecimal\/digits","kind":"symbol","type":"topic","url":"\/documentation\/bigdecimal\/bigdecimal\/digits"},"doc://BigDecimal/documentation/BigDecimal/BigDecimal/hypot(_:_:)":{"role":"symbol","title":"hypot(_:_:)","fragments":[{"kind":"keyword","text":"static"},{"kind":"text","text":" "},{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"hypot"},{"kind":"text","text":"("},{"kind":"typeIdentifier","text":"BigDecimal","preciseIdentifier":"s:10BigDecimalAAV"},{"kind":"text","text":", "},{"kind":"typeIdentifier","text":"BigDecimal","preciseIdentifier":"s:10BigDecimalAAV"},{"kind":"text","text":") -> "},{"kind":"typeIdentifier","text":"BigDecimal","preciseIdentifier":"s:10BigDecimalAAV"}],"abstract":[],"identifier":"doc:\/\/BigDecimal\/documentation\/BigDecimal\/BigDecimal\/hypot(_:_:)","kind":"symbol","type":"topic","url":"\/documentation\/bigdecimal\/bigdecimal\/hypot(_:_:)"},"doc://BigDecimal/documentation/BigDecimal":{"role":"collection","title":"BigDecimal","abstract":[{"type":"text","text":"The BigDecimal package provides arbitrary-precision (with an adjustable upper"},{"type":"text","text":" "},{"type":"text","text":"limit for performance) and fixed-precision decimal arithmetic in Swift."}],"identifier":"doc:\/\/BigDecimal\/documentation\/BigDecimal","kind":"symbol","type":"topic","url":"\/documentation\/bigdecimal"},"doc://BigDecimal/documentation/BigDecimal/BigDecimal/maxDigits":{"role":"symbol","title":"maxDigits","fragments":[{"kind":"keyword","text":"static"},{"kind":"text","text":" "},{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"kind":"identifier","text":"maxDigits"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"Int","preciseIdentifier":"s:Si"}],"abstract":[],"identifier":"doc:\/\/BigDecimal\/documentation\/BigDecimal\/BigDecimal\/maxDigits","kind":"symbol","type":"topic","url":"\/documentation\/bigdecimal\/bigdecimal\/maxdigits"},"doc://BigDecimal/documentation/BigDecimal/BigDecimal":{"role":"symbol","title":"BigDecimal","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"BigDecimal"}],"abstract":[{"type":"text","text":"A signed decimal value of unbounded precision (actually there is a"},{"type":"text","text":" "},{"type":"text","text":"practical limit defined by "},{"type":"reference","isActive":true,"identifier":"doc:\/\/BigDecimal\/documentation\/BigDecimal\/BigDecimal\/maxDigits"},{"type":"text","text":" of 200 that the user can change)."},{"type":"text","text":" "},{"type":"text","text":"A "},{"type":"reference","isActive":true,"identifier":"doc:\/\/BigDecimal\/documentation\/BigDecimal"},{"type":"text","text":" value is represented as a signed "},{"type":"codeVoice","code":"BInt"},{"type":"text","text":" significand"},{"type":"text","text":" "},{"type":"text","text":"and a signed "},{"type":"codeVoice","code":"Int"},{"type":"text","text":" exponent that is limited to ten digits."},{"type":"text","text":" "},{"type":"text","text":"The value of a Self is "},{"type":"reference","isActive":true,"identifier":"doc:\/\/BigDecimal\/documentation\/BigDecimal\/BigDecimal\/digits"},{"type":"text","text":" * 10^"},{"type":"reference","isActive":true,"identifier":"doc:\/\/BigDecimal\/documentation\/BigDecimal\/BigDecimal\/exponent"},{"type":"text","text":"."}],"identifier":"doc:\/\/BigDecimal\/documentation\/BigDecimal\/BigDecimal","kind":"symbol","type":"topic","navigatorTitle":[{"kind":"identifier","text":"BigDecimal"}],"url":"\/documentation\/bigdecimal\/bigdecimal"}}}