fsharp / fsharp/fsharp-core-docs

Discuss member panels

Aperta
#50 10 commenti 0 reazioni 0 assegnatari Vedi su GitHub
fsdocs
Lingua principale
Nessun dato sulla lingua
Stelle
37
Fork
20
Merge medio
6m
PR unite (30g)
1

Descrizione

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 of FSharp.Core where we have relatively populated XML comments, though it's a more general FSharp.Formatting issue

For FSharp.Core a typical member panel looks like this:

![image](https://user-images.githubusercontent.com/7204669/89324443-32d17580-d67f-11ea-8528-da8a5bde0e8d.png)

Now, the things I'd like some help with are

1. Should the parameter types and the parameter descriptions be merged together? The F#F codebase is now getting to a point where it's cleaned up enough (and I understand it well enough) to allow this to happen. But what visuals do we want? Are there any really nice docs elsewhere integrating type information and documentation you can point me to?

2. Do we actually need to move to generating one page per member, especially when example usage starts being added? A library like PyTorch doesn't do this but of course MSDN does.

3. The left-right display of the member usage feels like wasted space. Perhaps each member should be stacked.

Here's an example of PyTorch (not necesarily great documentation though nor exemplar for FSHarp.Core)

Member list:

![image](https://user-images.githubusercontent.com/7204669/89325446-b475d300-d680-11ea-82c3-ece963d4ddc6.png)

Member page:

![image](https://user-images.githubusercontent.com/7204669/89325193-5943e080-d680-11ea-817e-5f74a8d80cc4.png)

The things I notice are:

* one page for each member

* vertical stacking

* types go in italics , parenthesized

* only summary text on member list page

Guida per i contributori

Nessuna guida per i contributori indicizzata per questo repository

Valutazione

Questa issue non è ancora stata valutata.

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.