Docs need support for a multiversion changed/added marker.

Aberta
#101,716 1 comentário 1 reação 0 responsáveis Ver no GitHub

Ninguém assumiu esta issue ainda.

Avaliação

Dificuldade
5/5
Tempo estimado
Mais de uma semana
Facilidade para iniciantes
35/100
Tipo de issue
Funcionalidade
Clareza
Razoavelmente clara
Status de atividade
Estagnada
Stack de tecnologia
python
Domínio
documentation

Direção de pesquisa

Comece revisando as diretivas ReST existentes versionchanged e versionadded e como elas renderizam os valores de versão. Defina uma sintaxe e um comportamento de renderização para várias versões, incluindo correções de segurança retroportadas e a filtragem de versões futuras; considera-se concluído quando a documentação exibir cada release aplicável sem ambiguidade manual.

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

Descrição

docs type-feature

Documentation

We have .. versionchanged:: NUMERIC TEXT and .. versionadded:: NUMERIC TEXT support in our ReST docs.

But I believe it must be a single numeric value/word to render meaningfully? What we lack is the less commonly needed ability to specify multiple versions at once. Typically for a subset of security fix backports.

Today's common practice has been to just list the relevant version from the branch being committed to (example: in main 3.12 today, in 3.11: 3.11.99, etc.) with a manual change to the docs required within each backport PR.

This is somewhat unsatisfactory for documentation readers: People often link to and read the latest /3/ docs on the website regardless of the Python version they are using. Where a version marker saying something happened in a specific release often ignores that the change was back-ported to older releases. Meaning people may not realize that unless they happen to bother loading the older version specific documentation.

note: Adding multi-version support in the tags wouldn't address the manual PR change on back-port issue (references to future versions in changed/added markers don't belong there... unless we could we auto-filter those out based on version number at doc compilation time?) - but that, or better, automating initial version population into those fields from the surrounding codebase, belongs in a separate feature request.

Linguagem predominante
Python
Estrelas
77.2k
Forks
36k
Merge médio
1d 9h
PRs com merge (30d)
558

Guia de contribuição

Abrir o guia de contribuição

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 python/cpython

Todas as issues de python/cpython

Issues semelhantes

Mais issues de Python

Receba novas issues na sua caixa de entrada

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