The Wayback Machine - https://web.archive.org/web/20201101072813/https://github.com/tmenier/Flurl/issues/121
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

Updates to documentation #121

Open
tmenier opened this issue Jul 28, 2016 · 7 comments
Open

Updates to documentation #121

tmenier opened this issue Jul 28, 2016 · 7 comments
Assignees
Labels

Comments

@tmenier
Copy link
Owner

@tmenier tmenier commented Jul 28, 2016

For tracking updates and changes needed to the docs. I welcome community input here!

https://flurl.io/installation/

https://flurl.io/fluent-url/

  • Url.Combine enhancements

https://flurl.io/testable-http/

  • Query param assertions #102
  • Can test in parallel (except PCL)
  • Misc enhancements from 1.1.0 & 1.1.1

https://flurl.io/configuration/

  • Url is a Flurl.Url object, not a string

https://flurl.io/docs/client-lifetime/#using-flurl-with-an-ioc-container

  • Do NOT advise configuring FlurlClient in service ctor - it's not thread safe. When ConfigureClient is added to FlurlClientFactory, advise using that in service registration as I mentioned here.
@tmenier tmenier self-assigned this Jul 28, 2016
@tmenier tmenier added the website label Jul 28, 2016
@tmenier
Copy link
Owner Author

@tmenier tmenier commented Jul 28, 2016

@kroniak Could you suggest how best to document supported platforms (as of Flurl 2.2)? Here is how the docs currently read:

Both Flurl and Flurl.Http are Portable Class Libraries supporting the following platforms:

  • .NET Framework 4 and above for Flurl, 4.5 and above for Flurl.Http
  • Windows 8
  • Windows Phone 8.1
  • Windows Phone Silverlight 8
  • Xamarin.Android
  • Xamarin.iOS

I want to highlight .NET Core obviously. Do we say ".NET Core 1.0+"? What about targets such as NETStandard and UAP? They imply a collection of platforms, so they probably would not belong on this list, correct? Also MonoTouch/MonoAndroid are the same as Xamarin.iOS/Xamarin.Android, right?

We're in your world here, so any advice is appreciated!

@kroniak
Copy link
Collaborator

@kroniak kroniak commented Jul 28, 2016

@tmenier I think that the best is list target as in nuget package. About netcore say "Support NETCore 1.0.0 by NETStandard target 1.4". Like so.

You write something and we will review.

@tmenier
Copy link
Owner Author

@tmenier tmenier commented Jul 29, 2016

@kroniak How's this?

  • .NET Framework 4 and above for Flurl, 4.5 and above for Flurl.Http
  • .NET Core 1.0 (via .NET Standard 1.4)
  • Windows 8
  • Windows Phone 8.1
  • Windows Phone Silverlight 8
  • Xamarin.Android
  • Xamarin.iOS
  • Xamarin.Mac
  • UAP 1.0
  • MonoTouch
  • MonoAndroid
@tmenier
Copy link
Owner Author

@tmenier tmenier commented Jul 29, 2016

Hard to find good examples. NUnit lists theirs: https://www.nuget.org/packages/NUnit/

@kroniak
Copy link
Collaborator

@kroniak kroniak commented Jul 29, 2016

@tmenier Yep. I would have said: Minimal version:

Target Platform Name Alias Flurl Flurl.Http
.NET Platform Standard netstandard 1.4
.NET Core netcoreapp 1.0
.NET Framework net 4.0 4.5
Universal Windows Platform uap 10.0
Windows win 8.0
Windows Phone wpa 8.1
Windows Phone Silverlight wp 8.0
Mono/Xamarin Platforms
Mono
@cremor
Copy link

@cremor cremor commented Jun 9, 2018

@tmenier I'd suggest to document the work done for #222 on https://tmenier.github.io/Flurl/client-lifetime/

@tmenier
Copy link
Owner Author

@tmenier tmenier commented Jun 11, 2018

@cremor Agreed. Also noted in #330.

@tmenier tmenier added the next up label Nov 18, 2018
@tmenier tmenier added reviewed and removed next up labels Jan 18, 2019
@tmenier tmenier added this to Reviewed in Default Project Mar 24, 2019
@tmenier tmenier removed the reviewed label Mar 24, 2019
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
3 participants
You can’t perform that action at this time.