search

nhirschey / FSharp.Data.Fred

Wrapper for Federal Reserve Economic Data API https://nhirschey.github.io/FSharp.Data.Fred/
MIT License
3 stars 3 forks source link

Add XML documentation #13

Closed DavideGCosta closed 3 years ago

DavideGCosta commented 3 years ago

I erased all the comments and started documenting bit by bit. Everything went fine! The main problem was that I wasn't building every time, and for namespaces documentation, you need to dotnet build and then dotnet fsdocs watch --eval. So I ended up adding all the documentation I had, which I believe will help a lot when accessing the functions in VSCode.

Also, changed the information about downloading the package both in XML documentation and in the index.fsx (since we cannot use #r "nuget: FSharp.Data.Fred" but only #r "nuget: FSharp.Data.Fred, 0.1.0-beta.1".

Also, I find it strange that Series constructors as Search, Info, Observations, etc., do not appear on the website. I tried many things and searched online for the problem, but nothing worked. Is it normal? (It happened even after removing all comments). I tried to add extra documentation (seen in the image below) to help with this issue.

Screenshot 2021-10-13 at 19 51 46
nhirschey commented 3 years ago

since we cannot use #r "nuget: FSharp.Data.Fred"

We can once we release a non-beta version. It doesn’t grab betas. Please add that line back.

It should work with Series. That’s what I cannot figure out.

Add nuget thing back and then we’ll merge this in. We can then try again to figure out the series, search, etc problem.