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

Add Fake.Net.Http documentation & API update #1759

Merged
merged 3 commits into from
Jan 27, 2018

Conversation

vlukash
Copy link
Contributor

@vlukash vlukash commented Jan 18, 2018

  • Add Fake.Net.Http documentation
  • Change API to throw exceptions in case of error, so it's consistent with other APIs

@vlukash
Copy link
Contributor Author

vlukash commented Jan 18, 2018

Related to #1746

@vlukash vlukash force-pushed the vlukash/http_downloader_doc branch 2 times, most recently from 86f0354 to 14ff268 Compare January 19, 2018 08:08
@vlukash
Copy link
Contributor Author

vlukash commented Jan 19, 2018

Seems like documentation is not autogenerated (from *.dll) for the netcore projects if *.fs files aren't included in the legacy FakeLib.fsproj.

In this case, I don't see Fake.Net.Http namespace in the
https://fake.build/apidocs/index.html

I can probably modify "GenerateDocs" target in build.fsx, or include *.fs files in the FakeLib.fsproj

@matthid, do you know what is the right way to autogenerate docs for netcore projects?

@matthid
Copy link
Member

matthid commented Jan 19, 2018

Actually, I think the easiest way is to just include it into fakelib until we have worked that out...

@vlukash
Copy link
Contributor Author

vlukash commented Jan 20, 2018

Got it, thanks!
Updated FakeLib, ready for review

Copy link
Member

@matthid matthid left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks a lot. I can change the missing things after merging.

@@ -3,11 +3,13 @@
open Fake.Net.Async
open Fake.Net.Result

/// [omit]
// List extensions for traversing Result and Async types
// Functions from fsharpforfunandprofit.com, please see details here:
// https://fsharpforfunandprofit.com/posts/elevated-world-5/
module List =
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Maybe we should mark that internal?

@@ -1,7 +1,9 @@
namespace Fake.Net.Result

/// [omit]
module Result =
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

internal?

@matthid
Copy link
Member

matthid commented Jan 27, 2018

I think there is a place in build.fsx which needs to be edited if a new namespace (like Fake.Net here) is added. I'll try to put everything together

@matthid matthid merged commit a1e8a36 into fsprojects:master Jan 27, 2018
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

Successfully merging this pull request may close these issues.

2 participants