fsharp-core-docs
fsharp-core-docs copied to clipboard
fsharp
Generated API documentation for the FSharp.Core library. Generated using FSharp.Formatting.
https://fsharp.github.io/fsharp-compiler-docs/fcs/symbols.html The code sections on this page aren't rendering nicely at all.
Not sure if this is an error in documentation or purposeful omission, or perhaps a bug in fsharp. [Here](https://fsharp.github.io/fsharp-core-docs/reference/fsharp-core-operators.html#max) `max` is described as > Maximum based on generic comparison And...
https://github.com/fsharp/fsharp-core-docs/blob/7d5b8049262e298e6e620ff308ada7999b9a2d81/.github/workflows/docs.yml#L29 My main question is: Is it intentional to have the docs show pre-release functionality? I was writing a little app and forgot some syntax when using map. I checked...
I'd like us to consider working with the FSSF to move https://fsharp.github.io/fsharp-core-docs/ to https://docs.fsharp.org/reference As you know, Microsoft and the .NET Foundation host the F# language docs. However the FSharp.Core...
Hi all, I'd like to discuss the member panels (and the documentation for members more generally) coming out of FSharp.Formatting. I think it's good to do this in the context...
The [documentation for `hash`](https://fsharp.github.io/fsharp-core-docs/reference/fsharp-core-operators.html#hash) does not say that it requires the `equality` constraint on its only type parameter. Another example is the [documentation for `compare`](https://fsharp.github.io/fsharp-core-docs/reference/fsharp-core-operators.html#compare). It requires the `comparison` type...
I'm adding a warning into fsdocs to report missing parameters docs info. Here is the current list of warnings about incomplete documentation in FSHarp.Core (based on dotnet/fsharp feature/docs branch right...
The [query docs for each custom operator](https://fsharp.github.io/fsharp-core-docs/reference/fsharp-linq-querybuilder.html) need a `remarks` section (or a mention in the summary) about how the custom opreator is used At the moment there's no mention...
As noted by @baronfel in #27, the default styling and top-level layout needs improvement. What is here is the current default styling for FSharp.Formatting using the standard _template.html, which is...
The index.json search index cached by browsers may become out of date as the site gets refreshed This is an FSharp.Formatting issue (specifically in fsdocs-search.js) noted by @baronfel in https://github.com/fsharp/fsharp-core-docs/pull/27#issuecomment-667561113...