Description and usage of version is incorrect

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

@krowvin já está trabalhando nisso.

Desde 11/9/2026.

  • #319 de @krowvin — aberto

Avaliação

Dificuldade
1/5
Tempo estimado
Menos de uma hora
Facilidade para iniciantes
25/100
Tipo de issue
Documentação
Clareza
Claramente especificada
Status de atividade
Estagnada
Stack de tecnologia
python
Domínio
api, documentation

Direção de pesquisa

Abra cwms/api.py na linha 141 e compare as instruções do método com a distinção da issue entre a versão de release do CDA e o versionamento da API/dos dados. Consulte o pull request #319 vinculado para verificar o trabalho já em andamento; considera-se concluído quando o método e seu texto descritivo não implicarem mais que toda a API é versionada.

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

Descrição

The statements within https://github.com/HydrologicEngineeringCenter/cwms-python/blob/18b34b037ce32523ecdee287005c9219a1216e27/cwms/api.py#L141 are incorrect.

While CDA overall does have a version (the calendar data of release) the API itself is not versioned.

Data is versioned in the case of backwards incompatible changes.

This method and it's descriptive text imply the entire API is versioned - this is not correct.

Linguagem predominante
Python
Estrelas
16
Forks
11
Merge médio
7h 35min
PRs com merge (30d)
3

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 HydrologicEngineeringCenter/cwms-python

Todas as issues de HydrologicEngineeringCenter/cwms-python

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.