search

nhirschey / FSharp.Data.Fred

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

Improve XML documentation for API reference #5

Closed nhirschey closed 12 months ago

nhirschey commented 2 years ago

Need to improve XML comments for the autogenerated API reference. For example, none of the things are documented in the series module.

There’s nice documentation of stuff in index.fsx. So it should mostly be a matter of copying that info from index.fsx into XML comments so that both index.fsx and API reference have good docs.

nhirschey commented 12 months ago

Fixed by removing usemarkdowndocs from the fsproj in commit https://github.com/nhirschey/FSharp.Data.Fred/commit/4701faca1f84e5b103652f37eea88ae5199ce056