Hacktoberfest 2026: as issues que os mantenedores marcaram para outubro, abertas e boas para iniciantes. Ver issues do Hacktoberfest

Query docs for custom operators don't mention they are custom operators

Aberta
#55 1 comentário 0 reações 0 responsáveis Ver no GitHub

Ninguém assumiu esta issue ainda.

Avaliação

Dificuldade
3/5
Tempo estimado
1-2 dias
Facilidade para iniciantes
38/100
Tipo de issue
Documentação
Clareza
Razoavelmente clara
Status de atividade
Estagnada
Stack de tecnologia
fsharp
Domínio
documentation

Direção de pesquisa

Comece pela documentação de queries vinculada na issue e pelos comentários de documentação relevantes de FSharp.Core.xml; em seguida, inspecione como FSharp.Formatting produz o texto de uso. Atualize a documentação para que cada operador personalizado seja identificado e seu uso mostre tanto a sintaxe de chamada de método quanto a sintaxe de builder; estará concluído quando a documentação de queries gerada refletir ambas as formas.

Escrita pelo modelo de indexação a partir do texto da issue.

Descrição

The query docs for each custom operator need a remarks section (or a mention in the summary) about how the custom opreator is used

At the moment there's no mention of the custom operator, and the usage text looks like a method call.

Two sides to this

  • partly an FSharp.Core.xml problem (doc comment needs to mention this)

  • partly an F#F problem (adjust usage text to show both method call and builder syntax)

image

Linguagem predominante
Sem dados de linguagem
Estrelas
37
Forks
20
Merge médio
5min
PRs com merge (30d)
2

Preparar o ambiente

Este projeto não oferece contêiner de desenvolvimento, Dockerfile nem guia de contribuição, então a configuração fica por sua conta: comece pelo README e veja nosso guia da primeira contribuição para os passos gerais.

Primeiros passos

  1. Leia a issue inteira e depois o guia de contribuição do projeto.
  2. Comente na issue dizendo que vai assumir — evita que duas pessoas façam o mesmo trabalho.
  3. Faça um fork do repositório e trabalhe em uma branch.
  4. Abra um pull request que referencie o número da issue.

Mais de fsharp/fsharp-core-docs

Todas as issues de fsharp/fsharp-core-docs

Issues semelhantes

Mais issues de Documentation

Receba novas issues na sua caixa de entrada

Um resumo curto de issues do GitHub para quem está começando.