Clarify attribute names, or rename package ID about xunit.stafact HOT 8 CLOSED

The [UIFact] attribute does a little more than just set a SynchronizationContext. It also runs the test on an STA thread if on Windows.
I think I'll keep the names we have, but I'll improve the documentation on the package and attributes to better describe their features and behavior.

from xunit.stafact.

Would be great to have some documentation in README.md too, e.g. a table with the attributes and its primary intention.

from xunit.stafact.

Yes, I am preparing a 1.0 stable release. And you make a valid point about UIFact not really being UI specific. However, nearly everyone I've observed that deals with SynchronizationContext is also dealing with some UI framework, so it's accurate for that scenario, even though it is applicable more broadly than that. I'd rather not rename the attribute at this point because there are already over 100K downloads and I don't want to make upgrading more difficult than necessary.

As far as naming goes, I was most tempted to rename the package since hardly anyone is interested in StaFact actually -- they really want one of the other attributes that apply a SynchronizationContext. But that too, would probably disrupt more than help. I'm not sure. Maybe I'll rename and deprecate the original package on nuget.org so folks discover the new one.

from xunit.stafact.

IF you EVER rename attributes and/or package, then NOW.

from xunit.stafact.

@weltkante @RussKie @josetr @Serg046 @apobekiaris Do you have an opinion on the package ID? Should we keep it or rename it? Perhaps to UIFact.Xunit, since I think Xunit is now a reserved namespace on nuget.org. Or perhaps Nerdbank.XUnit.UIFact.

from xunit.stafact.

Personally I don't have any issues with renaming things. Not speaking for WinForms repo owners but I can do the necessary changes there as well if it becomes necessary, doesn't look like its integrated into arcade infrastructure so should be straightforward to apply any renaming of package references or code.

from xunit.stafact.

Thank you for asking, but I don't have a strong opinion. We'll use whatever the name is (assuming you're not planning to delist old versions).

I don't think we use anything but WinForms* or STA* attributes, so don't have a strong opinion about UI* attributes either. Though following the logic laid out above, I'd go for a longer name SynchronizationContext* purely for descriptive reasons.

from xunit.stafact.

Closed with 782b084.

from xunit.stafact.