eza-community/eza

bug: Problems with man pages

Aberta

#981 aberto em 10 de mai. de 2024

Ver no GitHubGuia do colaborador
 (6 comentários) (1 reação) (0 responsável)Rust (439 forks)batch import
good first issuetype: docs

Métricas do repositório

Stars
 (21.783 estrelas)
Métricas de merge de PR
 (Nenhuma PRs mesclada em 30d)

Description

Those are the ones I spotted right away, if there are more, please add in comments.

  1. There is no documentation for --absolute option
  2. Man pages contain $version string, which I think should be replaced with an actual eza version number
  3. in "SEE ALSO" section, man pages still point to markdown files, for example eza_colors.5.md . The .md suffix should be removed in man pages.

Guia do colaborador

Direção de pesquisa
Comece examinando os arquivos fonte da página de manual no diretório 'man' do repositório. Localize onde '$version' é usado e determine como ele deve ser substituído pela versão real do Cargo.toml. Para a opção ausente absolute, adicione uma descrição na página de manual apropriada. Remova os sufixos '.md' das referências SEE ALSO. Verifique se há scripts de build que geram as páginas de manual.
Pilha de tecnologia
rust
Domain
clidocumentation
Tipo Issue
Documentação
DifficultyDificuldade de implementação estimada para um novo contribuidor, de 1 para alterações muito pequenas a 5 para trabalho de nível especializado.
1
Tempo estimadoUm intervalo de tempo aproximado para um colaborador experiente investigar, implementar, testar e preparar um pull request.
Menos de 1 hora
Status da atividadeQuão disponível o issue aparece agora: novo, ativo, obsoleto, bloqueado ou aguardando entrada do mantenedor.
Ativo
ClarityCom que clareza o issue explica a mudança esperada, os critérios de aceitação e a próxima etapa.
Claro
Prerequisites
Gitman pages
Simpatia para novatosUma pontuação de 1 a 100 que estima o quão acessível este issue é para colaboradores iniciantes.
90