sirtimbly/IronCalc
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

FIX[docs]: Fixes broken links

Browse Source
This commit is contained in:
Nicolás Hatcher
2024-12-29 12:53:05 +01:00
committed by Nicolás Hatcher Andrés
parent b859af1dc4
commit d3af994866
5 changed files with 7 additions and 7 deletions
Download Patch File Download Diff File Expand all files Collapse all files

4
docs/src/functions/financial/fv.md
View File

@@ -21,14 +21,14 @@ If your interest rate varies between periods, use the [FVSCHEDULE](/functions/fi
* *nper* ([number](/features/value-types#numbers), required). "nper" stands for <u>n</u>umber of <u>per</u>iods, in this case the number of compounding periods to be taken into account. While this will often be an integer, non-integer values are accepted and processed. * *nper* ([number](/features/value-types#numbers), required). "nper" stands for <u>n</u>umber of <u>per</u>iods, in this case the number of compounding periods to be taken into account. While this will often be an integer, non-integer values are accepted and processed.
* *pmt* ([number](/features/value-types#numbers), required). "pmt" stands for <u>p</u>ay<u>m</u>en<u>t</u>, in this case the fixed amount paid or deposited each compounding period. * *pmt* ([number](/features/value-types#numbers), required). "pmt" stands for <u>p</u>ay<u>m</u>en<u>t</u>, in this case the fixed amount paid or deposited each compounding period.
* *pv* ([number](/features/value-types#numbers), [optional](/features/optional-arguments.md)). "pv" is the <u>p</u>resent <u>v</u>alue or starting amount of the asset (default 0). * *pv* ([number](/features/value-types#numbers), [optional](/features/optional-arguments.md)). "pv" is the <u>p</u>resent <u>v</u>alue or starting amount of the asset (default 0).
* *type* ([Boolean](/features/value-types/#booleans), [optional](/features/optional-arguments.md)). A logical value indicating whether the payment due dates are at the end (FALSE or 0) of the compounding periods or at the beginning (TRUE or any non-zero value). The default is FALSE when omitted. * *type* ([Boolean](/features/value-types#booleans), [optional](/features/optional-arguments.md)). A logical value indicating whether the payment due dates are at the end (FALSE or 0) of the compounding periods or at the beginning (TRUE or any non-zero value). The default is FALSE when omitted.
### Additional guidance ### Additional guidance
* Make sure that the *rate* argument specifies the interest rate or yield applicable to the compounding period, based on the value chosen for *nper*. * Make sure that the *rate* argument specifies the interest rate or yield applicable to the compounding period, based on the value chosen for *nper*.
* The *pmt* and *pv* arguments should be expressed in the same currency unit. * The *pmt* and *pv* arguments should be expressed in the same currency unit.
* To ensure a worthwhile result, one of the *pmt* and *pv* arguments should be non-zero. * To ensure a worthwhile result, one of the *pmt* and *pv* arguments should be non-zero.
* The setting of the *type* argument only affects the calculation for non-zero values of the *pmt* argument. * The setting of the *type* argument only affects the calculation for non-zero values of the *pmt* argument.
### Returned value ### Returned value
FV returns a [number](/features/value-types/#numbers) representing the future value expressed in the same [currency unit](/features/units) that was used for the *pmt* and *pv* arguments. FV returns a [number](/features/value-types#numbers) representing the future value expressed in the same [currency unit](/features/units) that was used for the *pmt* and *pv* arguments.
### Error conditions ### Error conditions
* In common with many other IronCalc functions, FV propagates errors that are found in any of its arguments. * In common with many other IronCalc functions, FV propagates errors that are found in any of its arguments.
* If too few or too many arguments are supplied, FV returns the [`#ERROR!`](/features/error-types.md#error) error. * If too few or too many arguments are supplied, FV returns the [`#ERROR!`](/features/error-types.md#error) error.

4
docs/src/functions/financial/pv.md
View File

@@ -19,14 +19,14 @@ PV can be used to calculate present value over a specified number of compounding
* *nper* ([number](/features/value-types#numbers), required). "nper" stands for <u>n</u>umber of <u>per</u>iods, in this case the number of compounding periods to be taken into account. While this will often be an integer, non-integer values are accepted and processed. * *nper* ([number](/features/value-types#numbers), required). "nper" stands for <u>n</u>umber of <u>per</u>iods, in this case the number of compounding periods to be taken into account. While this will often be an integer, non-integer values are accepted and processed.
* *pmt* ([number](/features/value-types#numbers), required). "pmt" stands for <u>p</u>ay<u>m</u>en<u>t</u>, in this case the fixed amount paid or deposited each compounding period. * *pmt* ([number](/features/value-types#numbers), required). "pmt" stands for <u>p</u>ay<u>m</u>en<u>t</u>, in this case the fixed amount paid or deposited each compounding period.
* *fv* ([number](/features/value-types#numbers), [optional](/features/optional-arguments.md)). "fv" is the <u>f</u>uture <u>v</u>alue at the end of the final compounding period (default 0). * *fv* ([number](/features/value-types#numbers), [optional](/features/optional-arguments.md)). "fv" is the <u>f</u>uture <u>v</u>alue at the end of the final compounding period (default 0).
* *type* ([Boolean](/features/value-types/#booleans), [optional](/features/optional-arguments.md)). A logical value indicating whether the payment due dates are at the end (FALSE or 0) of the compounding periods or at the beginning (TRUE or any non-zero value). The default is FALSE when omitted. * *type* ([Boolean](/features/value-types#booleans), [optional](/features/optional-arguments.md)). A logical value indicating whether the payment due dates are at the end (FALSE or 0) of the compounding periods or at the beginning (TRUE or any non-zero value). The default is FALSE when omitted.
### Additional guidance ### Additional guidance
* Make sure that the *rate* argument specifies the interest rate or yield applicable to the compounding period, based on the value chosen for *nper*. * Make sure that the *rate* argument specifies the interest rate or yield applicable to the compounding period, based on the value chosen for *nper*.
* The *pmt* and *fv* arguments should be expressed in the same currency unit. * The *pmt* and *fv* arguments should be expressed in the same currency unit.
* To ensure a worthwhile result, one of the *pmt* and *fv* arguments should be non-zero. * To ensure a worthwhile result, one of the *pmt* and *fv* arguments should be non-zero.
* The setting of the *type* argument only affects the calculation for non-zero values of the *pmt* argument. * The setting of the *type* argument only affects the calculation for non-zero values of the *pmt* argument.
### Returned value ### Returned value
PV returns a [number](/features/value-types/#numbers) representing the present value expressed in the same [currency unit](/features/units) that was used for the *pmt* and *fv* arguments. PV returns a [number](/features/value-types#numbers) representing the present value expressed in the same [currency unit](/features/units) that was used for the *pmt* and *fv* arguments.
### Error conditions ### Error conditions
* In common with many other IronCalc functions, PV propagates errors that are found in any of its arguments. * In common with many other IronCalc functions, PV propagates errors that are found in any of its arguments.
* If too few or too many arguments are supplied, PV returns the [`#ERROR!`](/features/error-types.md#error) error. * If too few or too many arguments are supplied, PV returns the [`#ERROR!`](/features/error-types.md#error) error.

2
docs/src/functions/math_and_trigonometry/cos.md
View File

@@ -21,7 +21,7 @@ $$
### Additional guidance ### Additional guidance
None. None.
### Returned value ### Returned value
COS returns a unitless [number](/features/value-types/#numbers) that is the trigonometric cosine of the specified angle. COS returns a unitless [number](/features/value-types#numbers) that is the trigonometric cosine of the specified angle.
### Error conditions ### Error conditions
* In common with many other IronCalc functions, COS propagates errors that are found in its argument. * In common with many other IronCalc functions, COS propagates errors that are found in its argument.
* If no argument, or more than one argument, is supplied, then COS returns the [`#ERROR!`](/features/error-types.md#error) error. * If no argument, or more than one argument, is supplied, then COS returns the [`#ERROR!`](/features/error-types.md#error) error.

2
docs/src/functions/math_and_trigonometry/sin.md
View File

@@ -21,7 +21,7 @@ $$
### Additional guidance ### Additional guidance
None. None.
### Returned value ### Returned value
SIN returns a unitless [number](/features/value-types/#numbers) that is the trigonometric sine of the specified angle. SIN returns a unitless [number](/features/value-types#numbers) that is the trigonometric sine of the specified angle.
### Error conditions ### Error conditions
* In common with many other IronCalc functions, SIN propagates errors that are found in its argument. * In common with many other IronCalc functions, SIN propagates errors that are found in its argument.
* If no argument, or more than one argument, is supplied, then SIN returns the [`#ERROR!`](/features/error-types.md#error) error. * If no argument, or more than one argument, is supplied, then SIN returns the [`#ERROR!`](/features/error-types.md#error) error.

2
docs/src/functions/math_and_trigonometry/tan.md
View File

@@ -21,7 +21,7 @@ $$
### Additional guidance ### Additional guidance
None. None.
### Returned value ### Returned value
TAN returns a unitless [number](/features/value-types/#numbers) that is the trigonometric tangent of the specified angle. TAN returns a unitless [number](/features/value-types#numbers) that is the trigonometric tangent of the specified angle.
### Error conditions ### Error conditions
* In common with many other IronCalc functions, TAN propagates errors that are found in its argument. * In common with many other IronCalc functions, TAN propagates errors that are found in its argument.
* If no argument, or more than one argument, is supplied, then TAN returns the [`#ERROR!`](/features/error-types.md#error) error. * If no argument, or more than one argument, is supplied, then TAN returns the [`#ERROR!`](/features/error-types.md#error) error.