Comments Query Loop block: Rename to Comments (but keep ID) #40763
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
|
Size Change: -206 B (0%) Total Size: 1.23 MB
ℹ️ View Unchanged
|
michalczaplinski
approved these changes
May 2, 2022
|
Hmm, looks like the e2e test is broken after all. I'm investigating. |
|
It appears that in the e2e test, for some reason, the block's name is not updated. The block shows up as Comments Query Loop but it should be just Comments:
|
I checked CI artifacts, but those seemed circumstantial and unrelated to the rename. I re-ran e2e tests, and they passed, so I think we're good here. |
|
That's weird 🤔 Because I saw the same failure happening locally on my machine. Could that be because some of the backports were merged into Core in the meantime (between the time I tested and you re-ran the CI)? |
Possibly (I did check the artifacts for the CI's e2e test failures before re-running though). |
|
It looks like the class name for the block remains |
Thanks for flagging @gziolo. FWIW, this PR changed the block name and file/directory names, but not the block ID. So to me, it seems to make sense that the block class name remains Curious to hear your thoughts 🙂 (FWIW, we're planning to tackle the ID change separately (#40506), or even merge the Comments Query Loop and Post Comments blocks after all (#40521).) |
|
I'm removing the |
This was referenced Jun 23, 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.
What?
Rename the Comments Query Loop block to Comments.
Why?
The block has never really been a query loop (the query can't really be customized, unlike the (post) Query).
And it no longer is just a loop: For parity with its monolithic predecessor block (Post Comments, which is now deprecated and hidden from the inserter), we're now adding Comments Title, Comments Pagination, and Post Comments Form blocks to its default template.
Furthermore, as a user looking for “a block to display my comments”, I probably wouldn’t click on “Comments Query Loop” as my first choice in the inserter.
So in order for this block to convey to the user that it is the "authoritative" block to display comments, I'd like to propose we rename it accordingly.
How?
Rename the block.
We have another PR (#40506) that would also change the block ID (from
core/comments-query-looptocore/comments). I opted to file a PR for just changing the block name (but not the ID) in order to de-risk this. (I'd still love if we could also change the ID, but this way, we can discuss it separately.)Testing Instructions
Verify that the block is now called 'Comments' in the inserter and elsewhere.