Skip to content

Commit bd152e8

Browse files
committed
(Docs)(maint) Fix formatting issues in strings
Adding backticks to some strings that are causing issues in the generated docs. These revolve around unescaped angle brackets `<>`.
1 parent b21bd8d commit bd152e8

File tree

2 files changed

+7
-7
lines changed

2 files changed

+7
-7
lines changed

lib/puppet/functions/camelcase.rb

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
# This function is compatible with the stdlib function with the same name.
44
#
55
# The function does the following:
6-
# * For a `String` the conversion replaces all combinations of *_<char>* with an upcased version of the
6+
# * For a `String` the conversion replaces all combinations of `*_<char>*` with an upcased version of the
77
# character following the _. This is done using Ruby system locale which handles some, but not all
88
# special international up-casing rules (for example German double-s ß is upcased to "Ss").
99
# * For an `Iterable[Variant[String, Numeric]]` (for example an `Array`) each value is capitalized and the conversion is not recursive.

lib/puppet/functions/new.rb

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -661,12 +661,12 @@
661661
# | Format | Default formats
662662
# | ------ | ---------------
663663
# | s | binary as unquoted UTF-8 characters (errors if byte sequence is invalid UTF-8). Alternate form escapes non ascii bytes.
664-
# | p | 'Binary("<base64strict>")'
665-
# | b | '<base64>' - base64 string with newlines inserted
666-
# | B | '<base64strict>' - base64 strict string (without newlines inserted)
667-
# | u | '<base64urlsafe>' - base64 urlsafe string
668-
# | t | 'Binary' - outputs the name of the type only
669-
# | T | 'BINARY' - output the name of the type in all caps only
664+
# | p | `'Binary("<base64strict>")'`
665+
# | b | `'<base64>'` - base64 string with newlines inserted
666+
# | B | `'<base64strict>'` - base64 strict string (without newlines inserted)
667+
# | u | `'<base64urlsafe>'` - base64 urlsafe string
668+
# | t | `'Binary'` - outputs the name of the type only
669+
# | T | `'BINARY'` - output the name of the type in all caps only
670670
#
671671
# * The alternate form flag `#` will quote the binary or base64 text output.
672672
# * The format `%#s` allows invalid UTF-8 characters and outputs all non ascii bytes

0 commit comments

Comments
 (0)