Documentatie & testen in de praktijk

Software-engineeringprincipes in Python

Adam Spannbauer

Machine Learning Engineer at Eastman

Projecten documenteren met Sphinx

  Voorbeeld Sphinx-pagina

Software-engineeringprincipes in Python

Klassen documenteren

class Document:
    """Analyseer tekstgegevens

    :param text: tekst om te analyseren

    :ivar text: tekst die oorspronkelijk aan de instantie is doorgegeven bij aanmaak
    :ivar tokens: Geparste lijst van woorden uit tekst
    :ivar word_counts: Teller met aantallen gebruikte hashtags in tekst
    """
    def __init__(self, text):
        ...
Software-engineeringprincipes in Python

Continue integratietesten

    Travis CI Logo

Voorbeeld Travis Output - Mislukt

Software-engineeringprincipes in Python

Continue integratietesten

  Voorbeeld Travis Output - Geslaagd

Software-engineeringprincipes in Python

Links en extra tools

Software-engineeringprincipes in Python

Aan de slag

Software-engineeringprincipes in Python

Preparing Video For Download...