Type Hints in Examples

[jgarte]

Hi,

What do you think if we were to type annotate the Examples section?

For example, in the magic square example, we could write the following code that returns the transpositions of a tone row as:

import abjad as aj

def make_transpositions(row: aj.TwelveToneRow) -> list[aj.TwelveToneRow]:
    transpositions = []
    for pitch_class in row.invert():
        n = pitch_class.number - row[0].number
        transposition = row.transpose(n)
        transpositions.append(transposition)
    return transpositions

I think this would document more clearly for newcomers on what they are supposed to be passing in to functions in the Examples documentation.

Just a thought.

I'd be happy to submit pull requests adding this if you think it is a good idea?

[trevorbaca]

Abjad itself is typehinted, because it's complex, and a library. But there's really no reason for Abjad users to typehint their own scores. So, no reason to typehint the examples, either.