Minor wording adjustment to migration guide #845
Conversation
| @@ -96,7 +96,7 @@ Assert.That(actualText, Does.StartWith("42"), $"Expected '{actualText}' to start | |||
| There are no code fixers for `FileAssert` and `DirectoryAssert`. They could be added, but we don't expect these to be | |||
| used too much. | |||
|
|
|||
| #### Convert Classic Assert into NUnit 4.x equivalent | |||
| #### Using Classic Asserts in NUnit 4.x | |||
There was a problem hiding this comment.
The steps outline how to migrate existing code to the new naming.
If you don't like Convert, as a minimum it should be Update.
There was a problem hiding this comment.
That's a good idea, I like "Update" over "Convert" as it feels "lighter".
What are your thoughts on Classic Asserts vs Classic-style Asserts ? I'm trying to think of wording for this section which emphasizes to the reader that they can choose to stick with their chosen style of asserts if it is the classic style - even if it means they must update the referenced class.
There was a problem hiding this comment.
What are your thoughts on
Classic AssertsvsClassic-style Asserts?
I'm happy with either.
There was a problem hiding this comment.
I suggest Updating from Classic Asserts in NUnit 4.x
And I suggest it should be "Classic Asserts". We're calling the whole idea of them classic, not just the style.
|
@stevenaw Can you link to some of these social media posts? If there are many negative on this, we should rethink, or invite to a poll, to figure out what the overall response is. |
|
@OsirisTerje nobody likes to have their cheese moved. I mentioned in prior conversation that it'll be one of those things that seems more like a psychic weight than it will actually end up being. We made the decision, and we've provided multiple bridges to the new world; no need to rethink based on social media (though it is still good to see it) |
|
Agreed with @SeanKilleen re: moving of cheese @OsirisTerje No need in my mind to conduct outreach or change approach at this time either. I agree we've provided a clear migration path and considered several different scenarios in it for users. |
|
Thank you @SeanKilleen and @manfred-brands for your feedback. I've updated the section title to |
I've noticed a bit of hesitation on social media about the changes to assert styles. I thought a minor wording change could help here, mostly around dropping the word "convert" in one of the headings to minimize apparent friction.
I'm unsure which of these could be preferable so I've gone with the shorter, first alternative in this PR for now:
or
@manfred-brands @SeanKilleen I know you each put a lot of work into the guide, so I'd appreciate your thoughts on this