Skip to content

Commit 953ddb3

Browse files
committed
Make readme deprecations more similar
1 parent 331118f commit 953ddb3

File tree

1 file changed

+26
-26
lines changed

1 file changed

+26
-26
lines changed

README.md

Lines changed: 26 additions & 26 deletions
Original file line numberDiff line numberDiff line change
@@ -1059,7 +1059,7 @@ For example:
10591059

10601060
#### `dig`
10611061

1062-
> DEPRECATED: This function has been replaced with a built-in [`dig`](https://docs.puppet.com/puppet/latest/function.html#dig) function as of Puppet 4.5.0. Use [`dig44()`](#dig44) for backwards compatibility or use the new version.
1062+
**Deprecated: This function has been replaced with a built-in [`dig`](https://docs.puppet.com/puppet/latest/function.html#dig) function as of Puppet 4.5.0. Use [`dig44()`](#dig44) for backwards compatibility or use the new version.**
10631063

10641064
Retrieves a value within multiple layers of hashes and arrays via an array of keys containing a path. The function goes through the structure by each path component and tries to return the value at the end of the path.
10651065

@@ -1518,31 +1518,31 @@ if $baz.is_a(String) {
15181518

15191519
#### `is_absolute_path`
15201520

1521-
**Deprecated. Will be removed in a future version of stdlib. See [`validate_legacy`](#validate_legacy).**
1521+
**Deprecated: Will be removed in a future version of stdlib. See [`validate_legacy`](#validate_legacy).**
15221522

15231523
Returns `true` if the given path is absolute.
15241524

15251525
*Type*: rvalue.
15261526

15271527
#### `is_array`
15281528

1529-
**Deprecated. Will be removed in a future version of stdlib. See [`validate_legacy`](#validate_legacy).**
1529+
**Deprecated: Will be removed in a future version of stdlib. See [`validate_legacy`](#validate_legacy).**
15301530

15311531
Returns `true` if the variable passed to this function is an array.
15321532

15331533
*Type*: rvalue.
15341534

15351535
#### `is_bool`
15361536

1537-
**Deprecated. Will be removed in a future version of stdlib. See [`validate_legacy`](#validate_legacy).**
1537+
**Deprecated: Will be removed in a future version of stdlib. See [`validate_legacy`](#validate_legacy).**
15381538

15391539
Returns `true` if the variable passed to this function is a Boolean.
15401540

15411541
*Type*: rvalue.
15421542

15431543
#### `is_domain_name`
15441544

1545-
**Deprecated. Will be removed in a future version of stdlib. See [`validate_legacy`](#validate_legacy).**
1545+
**Deprecated: Will be removed in a future version of stdlib. See [`validate_legacy`](#validate_legacy).**
15461546

15471547
Returns `true` if the string passed to this function is a syntactically correct domain name.
15481548

@@ -1557,55 +1557,55 @@ Returns true if the string passed to this function is a valid email address.
15571557

15581558
#### `is_float`
15591559

1560-
**Deprecated. Will be removed in a future version of stdlib. See [`validate_legacy`](#validate_legacy).**
1560+
**Deprecated: Will be removed in a future version of stdlib. See [`validate_legacy`](#validate_legacy).**
15611561

15621562
Returns `true` if the variable passed to this function is a float.
15631563

15641564
*Type*: rvalue.
15651565

15661566
#### `is_function_available`
15671567

1568-
**Deprecated. Will be removed in a future version of stdlib. See [`validate_legacy`](#validate_legacy).**
1568+
**Deprecated: Will be removed in a future version of stdlib. See [`validate_legacy`](#validate_legacy).**
15691569

15701570
Accepts a string as an argument and determines whether the Puppet runtime has access to a function by that name. It returns `true` if the function exists, `false` if not.
15711571

15721572
*Type*: rvalue.
15731573

15741574
#### `is_hash`
15751575

1576-
**Deprecated. Will be removed in a future version of stdlib. See [`validate_legacy`](#validate_legacy).**
1576+
**Deprecated: Will be removed in a future version of stdlib. See [`validate_legacy`](#validate_legacy).**
15771577

15781578
Returns `true` if the variable passed to this function is a hash.
15791579

15801580
*Type*: rvalue.
15811581

15821582
#### `is_integer`
15831583

1584-
**Deprecated. Will be removed in a future version of stdlib. See [`validate_legacy`](#validate_legacy).**
1584+
**Deprecated: Will be removed in a future version of stdlib. See [`validate_legacy`](#validate_legacy).**
15851585

15861586
Returns `true` if the variable returned to this string is an integer.
15871587

15881588
*Type*: rvalue.
15891589

15901590
#### `is_ip_address`
15911591

1592-
**Deprecated. Will be removed in a future version of stdlib. See [`validate_legacy`](#validate_legacy).**
1592+
**Deprecated: Will be removed in a future version of stdlib. See [`validate_legacy`](#validate_legacy).**
15931593

15941594
Returns `true` if the string passed to this function is a valid IP address.
15951595

15961596
*Type*: rvalue.
15971597

15981598
#### `is_ipv6_address`
15991599

1600-
**Deprecated. Will be removed in a future version of stdlib. See [`validate_legacy`](#validate_legacy).**
1600+
**Deprecated: Will be removed in a future version of stdlib. See [`validate_legacy`](#validate_legacy).**
16011601

16021602
Returns `true` if the string passed to this function is a valid IPv6 address.
16031603

16041604
*Type*: rvalue.
16051605

16061606
#### `is_ipv4_address`
16071607

1608-
**Deprecated. Will be removed in a future version of stdlib. See [`validate_legacy`](#validate_legacy).**
1608+
**Deprecated: Will be removed in a future version of stdlib. See [`validate_legacy`](#validate_legacy).**
16091609

16101610
Returns `true` if the string passed to this function is a valid IPv4 address.
16111611

@@ -1619,15 +1619,15 @@ Returns `true` if the string passed to this function is a valid MAC address.
16191619

16201620
#### `is_numeric`
16211621

1622-
**Deprecated. Will be removed in a future version of stdlib. See [`validate_legacy`](#validate_legacy).**
1622+
**Deprecated: Will be removed in a future version of stdlib. See [`validate_legacy`](#validate_legacy).**
16231623

16241624
Returns `true` if the variable passed to this function is a number.
16251625

16261626
*Type*: rvalue.
16271627

16281628
#### `is_string`
16291629

1630-
**Deprecated. Will be removed in a future version of stdlib. See [`validate_legacy`](#validate_legacy).**
1630+
**Deprecated: Will be removed in a future version of stdlib. See [`validate_legacy`](#validate_legacy).**
16311631

16321632
Returns `true` if the variable passed to this function is a string.
16331633

@@ -2142,7 +2142,7 @@ For example, `{ "key" => "value" }` becomes `"---\nkey: value\n"`.
21422142

21432143
#### `try_get_value`
21442144

2145-
**DEPRECATED:** replaced by `dig()`.
2145+
**Deprecated: replaced by `dig()`.**
21462146

21472147
Retrieves a value within multiple layers of hashes and arrays.
21482148

@@ -2191,7 +2191,7 @@ $value = try_get_value($data, 'a|b', [], '|')
21912191

21922192
#### `type3x`
21932193

2194-
**Deprecated**. This function will be removed in a future release.
2194+
**Deprecated: This function will be removed in a future release.**
21952195

21962196
Returns a string description of the type of a given value. The type can be a string, array, hash, float, integer, or Boolean. For Puppet 4, use the new type system instead.
21972197

@@ -2298,7 +2298,7 @@ validate_absolute_path($undefined)
22982298

22992299
#### `validate_array`
23002300

2301-
**Deprecated. Will be removed in a future version of stdlib. See [`validate_legacy`](#validate_legacy).**
2301+
**Deprecated: Will be removed in a future version of stdlib. See [`validate_legacy`](#validate_legacy).**
23022302

23032303
Validates that all passed values are array data structures. Terminates catalog compilation if any value fails this check.
23042304

@@ -2351,7 +2351,7 @@ validate_augeas($sudoerscontent, 'Sudoers.lns', [], 'Failed to validate sudoers
23512351

23522352
#### `validate_bool`
23532353

2354-
**Deprecated. Will be removed in a future version of stdlib. See [`validate_legacy`](#validate_legacy).**
2354+
**Deprecated: Will be removed in a future version of stdlib. See [`validate_legacy`](#validate_legacy).**
23552355

23562356
Validates that all passed values are either `true` or `false`.
23572357
Terminates catalog compilation if any value fails this check.
@@ -2398,7 +2398,7 @@ validate_cmd($haproxycontent, '/usr/sbin/haproxy -f % -c', 'Haproxy failed to va
23982398

23992399
#### `validate_domain_name`
24002400

2401-
**Deprecated. Will be removed in a future version of stdlib. See [`validate_legacy`](#validate_legacy).**
2401+
**Deprecated: Will be removed in a future version of stdlib. See [`validate_legacy`](#validate_legacy).**
24022402

24032403
Validate that all values passed are syntactically correct domain names. Aborts catalog compilation if any value fails this check.
24042404

@@ -2445,7 +2445,7 @@ validate_email_address($some_array)
24452445

24462446
#### `validate_hash`
24472447

2448-
**Deprecated. Will be removed in a future version of stdlib. See [`validate_legacy`](#validate_legacy).**
2448+
**Deprecated: Will be removed in a future version of stdlib. See [`validate_legacy`](#validate_legacy).**
24492449

24502450
Validates that all passed values are hash data structures. Terminates catalog compilation if any value fails this check.
24512451

@@ -2469,7 +2469,7 @@ validate_hash($undefined)
24692469

24702470
#### `validate_integer`
24712471

2472-
**Deprecated. Will be removed in a future version of stdlib. See [`validate_legacy`](#validate_legacy).**
2472+
**Deprecated: Will be removed in a future version of stdlib. See [`validate_legacy`](#validate_legacy).**
24732473

24742474
Validates an integer or an array of integers. Terminates catalog compilation if any of the checks fail.
24752475

@@ -2529,7 +2529,7 @@ validate_integer(1, 3, true)
25292529

25302530
#### `validate_ip_address`
25312531

2532-
**Deprecated. Will be removed in a future version of stdlib. See [`validate_legacy`](#validate_legacy).**
2532+
**Deprecated: Will be removed in a future version of stdlib. See [`validate_legacy`](#validate_legacy).**
25332533

25342534
Validates that the argument is an IP address, regardless of whether it is an IPv4 or an IPv6 address. It also validates IP address with netmask.
25352535

@@ -2645,7 +2645,7 @@ Always note such changes in your CHANGELOG and README.
26452645

26462646
#### `validate_numeric`
26472647

2648-
**Deprecated. Will be removed in a future version of stdlib. See [`validate_legacy`](#validate_legacy).**
2648+
**Deprecated: Will be removed in a future version of stdlib. See [`validate_legacy`](#validate_legacy).**
26492649

26502650
Validates a numeric value, or an array or string of numeric values. Terminates catalog compilation if any of the checks fail.
26512651

@@ -2663,7 +2663,7 @@ For passing and failing usage, see [`validate_integer`](#validate-integer). The
26632663

26642664
#### `validate_re`
26652665

2666-
**Deprecated. Will be removed in a future version of stdlib. See [`validate_legacy`](#validate_legacy).**
2666+
**Deprecated: Will be removed in a future version of stdlib. See [`validate_legacy`](#validate_legacy).**
26672667

26682668
Performs simple validation of a string against one or more regular expressions.
26692669

@@ -2704,7 +2704,7 @@ To force stringification, use quotes:
27042704

27052705
#### `validate_slength`
27062706

2707-
**Deprecated. Will be removed in a future version of stdlib. See [`validate_legacy`](#validate_legacy).**
2707+
**Deprecated: Will be removed in a future version of stdlib. See [`validate_legacy`](#validate_legacy).**
27082708

27092709
Validates that a string (or an array of strings) is less than or equal to a specified length
27102710

@@ -2734,7 +2734,7 @@ validate_slength(["discombobulate","moo"],17,10)
27342734

27352735
#### `validate_string`
27362736

2737-
**Deprecated. Will be removed in a future version of stdlib. See [`validate_legacy`](#validate_legacy).**
2737+
**Deprecated: Will be removed in a future version of stdlib. See [`validate_legacy`](#validate_legacy).**
27382738

27392739
Validates that all passed values are string data structures. Aborts catalog compilation if any value fails this check.
27402740

0 commit comments

Comments
 (0)