Skip to content

(DOCS) grammar fixes for find_file() function docs #7859

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Nov 25, 2019
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 9 additions & 9 deletions lib/puppet/functions/find_file.rb
Original file line number Diff line number Diff line change
@@ -1,19 +1,19 @@
# Finds an existing file from a module and returns its path.
#
# The argument to this function should be a String as a `<MODULE NAME>/<FILE>`
# reference, which will search for `<FILE>` relative to a module's `files`
# This function accepts an argument that is a String as a `<MODULE NAME>/<FILE>`
# reference, which searches for `<FILE>` relative to a module's `files`
# directory. (For example, the reference `mysql/mysqltuner.pl` will search for the
# file `<MODULES DIRECTORY>/mysql/files/mysqltuner.pl`.)
#
# This function can also accept:
#
# * An absolute String path, which will check for the existence of a file from anywhere on disk.
# * Multiple String arguments, which will return the path of the **first** file
# found, skipping non existing files.
# * An array of string paths, which will return the path of the **first** file
# found from the given paths in the array, skipping non existing files.
#
# The function returns `undef` if none of the given paths were found
# * An absolute String path, which checks for the existence of a file from anywhere on disk.
# * Multiple String arguments, which returns the path of the **first** file
# found, skipping nonexistent files.
# * An array of string paths, which returns the path of the **first** file
# found from the given paths in the array, skipping nonexistent files.
#
# The function returns `undef` if none of the given paths were found.
#
# @since 4.8.0
#
Expand Down