Skip to content

Typo in custom widgets section of docs #137

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.

Sign up for GitHub

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 2 commits into from
Jul 6, 2021
Merged

Typo in custom widgets section of docs #137

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
22ee705
Typo in custom widgets section of docs
drkane Jul 2, 2021
299b3d3
Need to be sorted alphabetically
simonw Jul 6, 2021
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
4 changes: 2 additions & 2 deletions docs/widgets.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -135,9 +135,9 @@ You can define your own custom widgets by creating templates with special names.

Decide on the column names that you wish to customize for, then sort them alphabetically and join them with hyphens to create your template name.

For example, you could define a widget that handles results returned as `placename`, `geojson` by creating a template called `geojson-label.html`.
For example, you could define a widget that handles results returned as `placename`, `geojson` by creating a template called `geojson-placename.html`.

Save that in one of your template directories as `django_sql_dashboard/widgets/geojson-label.html`.
Save that in one of your template directories as `django_sql_dashboard/widgets/geojson-placename.html`.

Any SQL query that returns exactly the columns `placename` and `geojson` will now be rendered by your custom template file.

Expand Down