Add validation to Notes admin to require a period or exclamation mark as the final character #641
Conversation
This file contains 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
… as the final character. By default the behaviour is on, but can be easily overridden via nucleus-config The list of allowed characters can also be amended via environment vars. Fixes #639
stevejalim
force-pushed
the
639-validation-for-notes-field
branch
from
ae3dc4a to
7d04adb
Compare
|
@dsmithpadilla if you'd like to test-drive this, feel free. It's Docker-based, so cloning the repo and using the steps in the description should be all you need to do |
robhudson
reviewed
Aug 24, 2022
| @@ -19,6 +23,22 @@ class Meta: | |||
| model = models.Note | |||
| fields = "__all__" | |||
|
|
|||
| def clean_note(self): | |||
| """Ensure Note entries end with appropriate punctuation | |||
There was a problem hiding this comment.
Error: docstring summary lines must end with appropriate puncutation. 😆
robhudson
approved these changes
Aug 24, 2022
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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 was requested in #639 as part of making it easier to standardise Release Notes content.
If an entry lacks an accepted terminating punctuation mark, we'll show a validation error in the admin and the author can try again:
By default the behaviour is on, but can be easily overridden via env vars (via
nucleus-config)The list of allowed characters can also be amended via environment vars.
Fixes #639
### To test
make shellthen./manage.py createsuperuserthen exit the shellmake run