Description and usage of version is incorrect

Ouverte
#146 1 commentaire 0 réactions 0 personnes assignées Voir sur GitHub

@krowvin y travaille déjà.

Depuis le 11/9/2026.

  • #319 par @krowvin — ouverte

Évaluation

Difficulté
1/5
Temps estimé
Moins d'une heure
Accessibilité débutants
25/100
Type d'issue
Documentation
Clarté
Clairement spécifiée
Activité
À l'abandon
Stack technique
python
Domaine
api, documentation

Piste de recherche

Ouvrez cwms/api.py à la ligne 141 et comparez les instructions de la méthode avec la distinction établie dans l’issue entre la version de publication de CDA et le versionnage de l’API/des données. Consultez la pull request #319 liée pour voir le travail déjà en cours ; la tâche est terminée lorsque la méthode et son texte descriptif n’impliquent plus que l’ensemble de l’API est versionné.

Rédigé par le modèle d'indexation à partir du texte de l'issue.

Description

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.

Langage dominant
Python
Étoiles
16
Forks
11
Merge moyen
7 h 35 min
PR mergées (30 j)
3

Préparer son environnement

Par où commencer

  1. Lisez l'issue en entier, puis le guide de contribution du projet.
  2. Signalez en commentaire que vous la prenez — cela évite que deux personnes fassent le même travail.
  3. Forkez le dépôt et travaillez sur une branche.
  4. Ouvrez une pull request qui référence le numéro de l'issue.

Autres issues de HydrologicEngineeringCenter/cwms-python

Toutes les issues de HydrologicEngineeringCenter/cwms-python

Issues similaires

Plus d'issues Python

Recevez les nouvelles issues par e-mail

Un résumé court des issues GitHub adaptées aux débutants.