Hacktoberfest 2026: los issues que los mantenedores marcaron para octubre, abiertos y aptos para principiantes. Explorar issues de Hacktoberfest

Discuss member panels

Abierto
#50 10 comentarios 0 reacciones 0 asignados Ver en GitHub

Nadie ha tomado este issue todavía.

Evaluación

Dificultad
5/5
Tiempo estimado
Más de una semana
Aptitud para principiantes
20/100
Tipo de issue
Nueva funcionalidad
Claridad
Necesita aclaración
Estado de actividad
Estancado
Stack tecnológico
fsharp
Área
documentation

Línea de trabajo

Empieza revisando la generación de member-panel de FSharp.Formatting en el contexto de los comentarios XML de FSharp.Core referenciados aquí. Compara las descripciones propuestas combinadas de tipos y parámetros, las páginas por miembro, la disposición vertical y las listas que solo contienen resúmenes con los ejemplos de PyTorch; se considerará terminado cuando se haya alcanzado y documentado una decisión de diseño definitiva.

Escrito por el modelo de indexación a partir del texto del issue.

Descripción

fsdocs

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

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

Member page:

image

The things I notice are:

  • one page for each member

  • vertical stacking

  • types go in italics , parenthesized

  • only summary text on member list page

Lenguaje dominante
Sin datos de lenguaje
Estrellas
37
Forks
20
Merge medio
5 min
PR fusionados (30 d)
2

Guía de contribución

No hay ninguna guía de contribución indexada para este repositorio

Primeros pasos

  1. Lee el issue completo y luego la guía de contribución del proyecto.
  2. Comenta en el issue que vas a ocuparte — evita que dos personas hagan lo mismo.
  3. Haz un fork del repositorio y trabaja en una rama.
  4. Abre un pull request que haga referencia al número del issue.

Más de fsharp/fsharp-core-docs

Todos los issues de fsharp/fsharp-core-docs

Issues similares

Más issues de Documentation

Recibe los nuevos issues en tu correo

Un resumen breve de issues de GitHub para principiantes.