diff --git a/CHANGELOG.md b/CHANGELOG.md index 505f72e1..6dbafcda 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -12,7 +12,7 @@ - Change Poetry version to be `>=1.1.12,<2` in Docker development setup (prevents `JSONDecodeError` issue under Python 3.10) [#178](https://github.com/torchbox/django-pattern-library/pull/178) - Move demo/test app pattern-library from `/pattern-library/` to `/` [#178](https://github.com/torchbox/django-pattern-library/pull/178) -- Allow `.yml` extension for YAML files. ([#161](https://github.com/torchbox/django-pattern-library/issues/161)) +- Allow `.yml` extension for YAML files ([#161](https://github.com/torchbox/django-pattern-library/issues/161)). ### Removed diff --git a/docs/getting-started.md b/docs/getting-started.md index 74ac14f5..27f67436 100644 --- a/docs/getting-started.md +++ b/docs/getting-started.md @@ -159,8 +159,7 @@ We additionally need to customize a base template, so the standalone component c ### Component data -We can provide context and tags overrides for our new component by creating a `quote_block.yaml` YAML file alongside the HTML, at `patterns/components/quote_block/quote_block.yaml` in our example. -(You can use either `.yaml` or `.yml` as the file extension.) +We can provide context and tags overrides for our new component by creating a `quote_block.yaml` YAML file alongside the HTML, at `patterns/components/quote_block/quote_block.yaml` in our example. You can use either `.yaml` or `.yml` as the file extension. ```yaml context: diff --git a/docs/reference/api.md b/docs/reference/api.md index 6cabd3a6..27d10734 100644 --- a/docs/reference/api.md +++ b/docs/reference/api.md @@ -6,7 +6,7 @@ YAML isn’t everyone’s favorite markup language, but it has the advantage of Here is what you need to know: -- Use `.yaml` or `.yml` as file extention for patterns configuration files. If both are present, the `.yaml` file takes precendence. +- Use `.yaml` or `.yml` as the file extension for pattern configuration files. If both are present, the `.yaml` file takes precendence. - Use Mappings in place of Python Dictionaries. - Use Sequences in place of Python lists (or iterables like QuerySets). - The pattern library uses [PyYAML](https://pyyaml.org/wiki/PyYAMLDocumentation) in particular