Fix Typos in Documentation (#359)

* Fix unclosed code formatting Signed-off-by: ArtofBugs <74070945+ArtofBugs@users.noreply.github.com>
sous-chefs · May 23, 2024 · 9942ce0 · 9942ce0
1 parent 1473fab
commit 9942ce0
Show file tree

Hide file tree

Showing 3 changed files with 12 additions and 10 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -4,6 +4,8 @@ This file is used to list changes made in each version of the PHP cookbook.
 
 ## Unreleased
 
+- Fix typos in documentation for `php_install` and `php_ini` resources
+
 ## 10.0.1 - *2024-05-23*
 
 - Standardise files with files in sous-chefs/repo-management

diff --git a/documentation/php_ini.md b/documentation/php_ini.md
@@ -1,4 +1,4 @@
-# `php_install`
+# `php_ini`
 
 Adds a `php.ini` to the appropriate location.
 
@@ -11,8 +11,8 @@ Adds a `php.ini` to the appropriate location.
 
 | Name                | Type             | Default                                               | Description                                                 |
 | ------------------- | ---------------- | ----------------------------------------------------- | ----------------------------------------------------------- |
-| `conf_dir`          | `String`         | Platform-specific - see `libraries/helpers.rb         | Directory to place the `php.ini` file under                 |
-| `ini_template       | `String`         | `php.ini.erb` (see `templates/<distro>/php.ini.rb`)   | Template to use to create the `php.ini` file                |
+| `conf_dir`          | `String`         | Platform-specific - see `libraries/helpers.rb`        | Directory to place the `php.ini` file under                 |
+| `ini_template`      | `String`         | `php.ini.erb` (see `templates/<distro>/php.ini.rb`)   | Template to use to create the `php.ini` file                |
 | `ini_cookbook`      | `String`         | `php` (this cookbook)                                 | Cookbook where the template is located                      |
 | `directives`        | `Hash`           | `{}`                                                  | Directive-value pairs to add to the `php.ini` file          |
 | `ext_dir`           | `String`         | Platform-specific - see `libraries/helpers.rb`        | Directory in which the loadable extensions (modules) reside |

diff --git a/documentation/php_install.md b/documentation/php_install.md
@@ -10,13 +10,13 @@ By default, installs the `php` packages appropriate for your platform and adds a
 
 | Name                | Type             | Default                                               | Description                                                 |
 | ------------------- | ---------------- | ----------------------------------------------------- | ----------------------------------------------------------- |
-| `packages`          | `String`         | Platform-specific - see `libraries/helpers.rb`        | Packages to install                                         |
-| `options`           | `[String, Array] |                                                       | Installation options (see Chef `package` resource)          |
-| `conf_dir`          | `String`         | Platform-specific - see `libraries/helpers.rb         | Directory to place the `php.ini` file under                 |
-| `ini_template       | `String`         | `php.ini.erb` (see `templates/<distro>/php.ini.rb`)   | Template to use to create the `php.ini` file                |
-| `ini_cookbook`      | `String`         | `php` (this cookbook)                                 | Cookbook where the template is located                      |
-| `directives`        | `Hash`           | `{}`                                                  | Directive-value pairs to add to the `php.ini` file          |
-| `ext_dir`           | `String`         | Platform-specific - see `libraries/helpers.rb`        | Directory in which the loadable extensions (modules) reside |
+| `packages`          | `String`          | Platform-specific - see `libraries/helpers.rb`        | Packages to install                                         |
+| `options`           | `[String, Array]` |                                                       | Installation options (see Chef `package` resource)          |
+| `conf_dir`          | `String`          | Platform-specific - see `libraries/helpers.rb`        | Directory to place the `php.ini` file under                 |
+| `ini_template`      | `String`          | `php.ini.erb` (see `templates/<distro>/php.ini.rb`)   | Template to use to create the `php.ini` file                |
+| `ini_cookbook`      | `String`          | `php` (this cookbook)                                 | Cookbook where the template is located                      |
+| `directives`        | `Hash`            | `{}`                                                  | Directive-value pairs to add to the `php.ini` file          |
+| `ext_dir`           | `String`          | Platform-specific - see `libraries/helpers.rb`        | Directory in which the loadable extensions (modules) reside |
 
 ## Examples