Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Document that *Source attributes permit Task<IEnumerable> return types #756

Open
stevenaw opened this issue May 21, 2023 · 5 comments
Open

Comments

@stevenaw
Copy link
Member

stevenaw commented May 21, 2023

Method-based *Source attributes gained support for async return types in upcoming v4 and v3.14 framework versions via nunit/nunit#2729
It would be good to document this change. List of updated attributes can be found in nunit/nunit#4389

  • TestCaseSource
  • ValueSource
  • TestFixtureSource
@stevenaw stevenaw self-assigned this May 22, 2023
@stevenaw
Copy link
Member Author

stevenaw commented Jun 2, 2023

@SeanKilleen Curious, how would something like this be approached for unreleased changes? Is there a "prerelease" section of the docs, or should a PR be put up and just not merged until the framework changes are released?

@OsirisTerje
Copy link
Member

@stevenaw FWIW: I have been in the same situation for the adapter, and I chose to add a note to indicate from which version the feature was available. E.g. see https://docs.nunit.org/articles/vs-test-adapter/Tips-And-Tricks.html#where

For future features I know which version it goes into, so I add that upcoming version number.

@SeanKilleen
Copy link
Member

@stevenaw yep, @OsirisTerje is correct here -- I'll see if anything changed but docfx is a little clunky here; it doesn't easily allow multiple versions of docs AFAIK.

@stevenaw
Copy link
Member Author

stevenaw commented Jun 3, 2023

Thanks @OsirisTerje @SeanKilleen !
I'll give that a try.

@stevenaw
Copy link
Member Author

stevenaw commented Sep 7, 2023

Spare time has been a bit hard to come by lately. I'm going to remove my assignment from this for now in case anyone else wishes to pick this up

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

3 participants