Explain naming scheme for Node, Action, etc, in documentation

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

Mantenedores costumam responder em até 1 dia

Ninguém assumiu esta issue ainda.

Avaliação

Dificuldade
3/5
Tempo estimado
1-2 dias
Facilidade para iniciantes
35/100
Tipo de issue
Documentação
Clareza
Razoavelmente clara
Status de atividade
Estagnada
Stack de tecnologia
rust

Direção de pesquisa

Comece pelas páginas docs.rs de Action, DefaultActionVerb, NodeBuilder e Node e, em seguida, identifique as especificações correspondentes da Chromium accessibility API que definem seus nomes e sua semântica. O trabalho estará concluído quando cada um dos quatro tipos tiver um link para sua especificação Chromium relevante, para que os leitores possam usá-la como referência.

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

Descrição

AccessKit includes a few types with undocumented methods, variants, etc:

It's clear enough that these method/variant names come from somewhere, but it's not clear what. My understanding from what you said is that the names come from the Chromium accessibility API? But I'm not sure what that API even is.

While in the long term it would be better to document every property, in the short term it would be nice if the four types listed above could include a link to respective page for the Chromium spec they draw from. This way people trying to understand AccessKit's semantics could at least use the Chromium spec as a starting point.

Linguagem predominante
Rust
Estrelas
1.5k
Forks
133
Merge médio
16h 45min
PRs com merge (30d)
12

Preparar o ambiente

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 AccessKit/accesskit

Todas as issues de AccessKit/accesskit

Issues semelhantes

Mais issues de Rust

Receba novas issues na sua caixa de entrada

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