Support Markdown in dashboard descriptions.#118
Merged
simonw merged 2 commits intosimonw:mainfrom Jun 6, 2021
Merged
Conversation
Contributor
Author
|
Note that I just formatted the code using Black 21.5b1, but I'm not sure if it formats code differently from whatever version of Black you're using... I filed #119 to deal with this separately. |
Owner
|
I'm fine with the migration. The release log for this project currently just lives at https://github.com/simonw/django-sql-dashboard/releases - though maybe it should move into the docs folder now? I'll be sure to mention this as a potentially breaking change when I write the release notes there. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
This fixes #115 by supporting Markdown in dashboard descriptions. It also mentions that Markdown is allowed in all user-facing views.
Notes
I thought it would help to mention that Markdown is allowed in the Django-admin view, so I added
help_textto thedescriptionmodel field, e.g.:However, this required adding a new database migration, which is annoying because it doesn't actually change the database schema. If you're loath to do this, I could try "hacking" the
help_textinto an earlier migration, since it doesn't make a difference in practice.I couldn't see any kind of changelog, so I wasn't sure where to mention that this is technically a breaking change.