dotnet / dotnet/fsharp

Follow inheritdoc

Open
#3,827 0 comments 7 reactions 0 assignees View on GitHub
Feature Improvement
Dominant language
F#
Stars
4.3k
Forks
876
Avg merge
4d 11h
Merged PRs (30d)
131

Description

Functions with `inheritdoc` should give the inherited documentation on mouseover etc. For example:

```f#
open System.Reactive.Linq

///
let throttle (period:TimeSpan) source =
Observable.Throttle (source, period)
```

When hovering over the function name, no documentation it shown. It does, however, show a lot of empty space (see image) that's not present if I remove the doc comment altogether.

![image](https://user-images.githubusercontent.com/7766733/32043871-3fb2dc38-ba3c-11e7-929b-e2abc5c02e5b.png)

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.