mirrors/django-cotton
1
0
Fork 0
mirror of https://github.com/wrabit/django-cotton.git synced 2025-08-04 15:18:20 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

improve clarity of achieving hyphenated filenames

Browse source
This commit is contained in:
Will Abbott 2024-11-06 15:59:51 +00:00
parent c8155fd8d7
commit a605c29174
2 changed files with 2 additions and 2 deletions
Download patch file Download diff file Expand all files Collapse all files

2
docs/docs_project/docs_project/templates/components.html
View file

@ -94,7 +94,7 @@
</c-snippet>
<c-note>
Component filenames should be <c-highlight>snake_cased</c-highlight> by default, but you can change this behaviour by adding <code>COTTON_SNAKE_CASED_NAMES</code> to <code>False</code> in your settings.py, <a href="{% url 'configuration' %}">read more</a>.
Component filenames should be <c-highlight>snake_cased</c-highlight> by default. If you want to use hyphenated filenames instead, set <code>COTTON_SNAKE_CASED_NAMES</code> to <code>False</code> in your settings.py, <a href="{% url 'configuration' %}">read more</a>.
</c-note>
<c-hr />

2
docs/docs_project/docs_project/templates/configuration.html
View file

@ -21,7 +21,7 @@
<div>bool (default: True)</div>
</div>
<div>
<div class="mb-4">By default cotton will look for snake case versions of your component names. To turn this behaviour off (useful if you want to permit hyphenated filenames).</div>
<div class="mb-4">By default cotton will look for snake case versions of your component names. To turn this behaviour off (useful if you want to permit hyphenated filenames) then set this key to <code>False</code>.</div>
<div class="mb-4">
<h6 class="mb-1">Example:</h6>