Update Image Format.classnames to be Format.classname #10987
Merged
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
Manage this branch in SquashTest this branch here: https://lb-cleanupupdate-classname-pro-g2ktn.squash.io |
lb-
commented
Oct 3, 2023
| @@ -115,11 +115,11 @@ The unique key used to identify the format. To unregister this format, call `unr | |||
| **`label`**\ | |||
| The label used in the chooser form when inserting the image into the `RichTextField`. | |||
|
|
|||
| **`classnames`**\ | |||
| **`classname`**\ | |||
| The string to assign to the `class` attribute of the generated `<img>` tag. | |||
There was a problem hiding this comment.
These docs are really only for the args, as these are not kwargs the naming here does not matter but I thought it would be good to update nonetheless.
I have intentionally not included a changed in 5.2 note as I thought this would just cause more confusion.
lb-
commented
Oct 3, 2023
| @@ -25,7 +25,7 @@ class SubclassedImageFormat(Format): | |||
|
|
|||
|
|
|||
| register_image_format( | |||
| SubclassedImageFormat('subclassed_format', 'Subclassed Format', classnames, filter_spec) | |||
| SubclassedImageFormat('subclassed_format', 'Subclassed Format', 'image-classes object-contain', filter_spec) | |||
There was a problem hiding this comment.
Just updated the example code to be more 'real world', instead of some uncleared variable classname.
lb-
commented
Oct 3, 2023
lb-
commented
Oct 3, 2023
|
If it's ok, seeing as this is the last (I think) dev facing usage of |
zerolab
approved these changes
Oct 4, 2023
🌟
lb-
force-pushed
the
cleanup/update-classname-property-image-format
branch
from
dd7df4a
to
432bee3
Compare
- Aligns with the naming convention set from Wagtail 4.2 - Add deprecation warnings if classnames is accessed & unit tests for this - Update other unit tests to use the naming
lb-
force-pushed
the
cleanup/update-classname-property-image-format
branch
from
432bee3
to
02c78f2
Compare
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.
Format.classnameis the last of theclassnamesnaming migrations, this will help Wagtail be more predictable for developers and builds on the work already done over the last year.This usage is not fully 'public'/'documented', but I have included some upgrade considerations and a deprecation path nonetheless.
classnameinstead ofclassnamesin all MenuItem/Sidebar usage #10907 & Ensure icon template tag can useclassnameinstead ofclass_nameby default #9769 & Ensure all icon template tags useclassnameinstead ofclass_name& add deprecation warning #9770