FSharp.Formatting

FSharp.Formatting copied to clipboard

The examples for the API needs a common way to represent the results

4

Taking [Option.fold documentation example](https://github.com/dotnet/fsharp/blob/2cd818abf98240109a9ca9ad4982faeea2f8fdf5/src/fsharp/FSharp.Core/option.fsi#L153) as an example you will notice that the output of the example is embedded as a code comment There are cases where the sample together with...

MecuSorin

See https://github.com/DiffSharp/DiffSharp/pull/371#issuecomment-905557778

dsyme

Can't load native library in literate script

1

I'm writing [DiffSharp](https://github.com/DiffSharp/DiffSharp) docs using the tools in this repo. I need to make use of [literate scripts](https://fsprojects.github.io/FSharp.Formatting/literate.html) to produce docs that have F# code executed with the `--eval` argument...

gbaydin

saveImages flag is not documented or tested

1

1. The `saveImages` flag came from FsLab's literate scripting. It is not documented or tested. 2. The docs don't explain how to embed image outputs specifically, just some general information...

dsyme

Consider publishing a sass package for styling

4

Publishing a sass package for the styling (and compiling the `fsdocs-default.css` file from it) would highly benefit the expandability of the package and make template generation easier. As this library...

kMutagene

Large tooltip goes wild at the end of a file

2

See attached video. Navigate here and scroll to the bottom of the page: https://plotly.net/reference/plotly-net-layout.html Then hover over near the end of the signature. It will rapidly jitter the screen and...

cartermp

Template keywords are not always replaced

1

__Background__ Hi, I'm trying to understand how and where keyword replacements work. I don't know if "keyword" is the correct name for this feature. The following ``` (** Testing {{fsdocs-package-version}}...

gbaydin

Unhelpful error message when you try to include a snippet that doesn't exist

1

If I try to `(*** include:sample ***)` but I misspell it as `(*** include:smaple ***)` I get an error message like what is below that is not very helpful for...

nhirschey

Resolve links in docs for F# libraries to types defined in FSharp.Core

6

We currently give links for intra-collection types and .NET types, but not for FSharp.Core Now FSharp.Core is getting more stable, linkable docs we can start to generate links for types...

dsyme

Evaluation not working when using conditions

2

I am trying to use conditions to render both html and ipynb from `.fsx` files. The content of the resulting files itself looks fine, but evaluation via `(***include-it-raw***)` does not...

kMutagene