Garanzie quanto al versionamento

La libreria segue il principio di versionamento semantico <https://semver.org/>`_, implicando che la libreria ed aggiornata ad una versione maggiore dopo ogni modifica di rottura dell’API. Tuttavia, il manco di garanzia dalla parte di Discord a questo proposito e la natura dinamica di Python ed impossibile definire cosa sarebbe o no una modifica di rottura.

La prima cosa da ricordare è che modifiche di rottura avverrebbero unicamente per funzioni e classi definite pubblicamente. Se qualcosa non è listato qui nella documentazione, vuole dire che non fa parte dell’API pubblica e può cambiare a qualsiasi momento. Questo include attributi cominciando con un trattino basso o qualsiasi funzione non documentata qui.

Nota

Gli esempi sottostanti non sono esaustivi.

Esempi di modifiche di rottura

  • Cambiare il valore predefinito di un parametro.

  • Rinominare una funzione senza dargli un alias.

  • Aggiungere o togliere dei parametri a un evento.

Esempi di modifiche non di rottura

  • Aggiungere o togliere attributi privati con un trattino basso.

  • Aggiungere un elemento agli __slots__ di una dataclass.

  • Modificare il comportamento di una funzione nell’obiettivo di risolvere un bug.

  • Modificare la documentazione.

  • Modificare l’API interna.

  • Aggiornare le dipendenze a una nuova versione, sia maggiore o non.