Ich möchte einen Typparameter für eine meiner generischen Datenklassen mit einem Dokumentstring im Google-Stil annotieren, um sowohl das Generieren von Dokumentation als auch das Bewegen der Maus innerhalb von VS Code (und anderen Editoren/IDEs) zu unterstützen. Wenn ich Dokumentzeichenfolgen im Numpy-Stil verwende, scheint es beim Bewegen der Maus zu funktionieren. Wenn ich jedoch versuche, den Google-Stil zu verwenden, funktioniert es nicht. Bisher habe ich nur sehr wenig bis gar keine Dokumentation dazu gefunden, wie man einen Typparameter mit Docstrings im Google-Stil annotiert. Die nächstgelegene Dokumentation, die ich gefunden habe, ist:
Code: Select all
@final
@dataclass(frozen=True)
class MyDataclass[T]:
"""
A generic frozen dataclass.
Type Parameters:
T: A type parameter for this dataclass.
Attributes:
attribute (str): This dataclass's `string` attribute.
"""
attribute: str
Ich möchte nur wissen, ob das tatsächlich richtig ist oder ob Google-Dokumentzeichenfolgen überhaupt das Annotieren von Typparametern unterstützen.