Test documentation for variable

shimmer/types.py

@@ -3,8 +3,11 @@
 
 import torch
 
+test = ""
+"""Does this show ?"""
+
 RawDomainGroupT = Mapping[str, Any]
-RawDomainGroupT.__doc__ = """
+"""
 Matched raw unimodal data from multiple domains.
 Keys of the mapping are domains names.
 
@@ -14,7 +17,7 @@
 """
 
 RawDomainGroupDT = dict[str, Any]
-RawDomainGroupDT.__doc__ = """
+"""
 Matched raw unimodal data from multiple domains.
 Keys of the dict are domains names.
 
@@ -26,7 +29,7 @@
 """
 
 LatentsDomainGroupT = Mapping[str, torch.Tensor]
-LatentsDomainGroupT.__doc__ = """
+"""
 Matched unimodal latent representations from multiple domains.
 Keys of the mapping are domains names.
 
@@ -36,7 +39,7 @@
 """
 
 LatentsDomainGroupDT = dict[str, torch.Tensor]
-LatentsDomainGroupDT.__doc__ = """
+"""
 Matched unimodal latent representations from multiple domains.
 Keys of the dict are domains names.
 
@@ -48,7 +51,7 @@
 """
 
 LatentsDomainGroupsT = Mapping[frozenset[str], LatentsDomainGroupT]
-LatentsDomainGroupsT.__doc__ = """
+"""
 Mapping of `LatentsDomainGroupT`. Keys are frozenset of domains matched in the group.
 Each group is independent and contains different data (unpaired).
 
@@ -58,7 +61,7 @@
 """
 
 LatentsDomainGroupsDT = dict[frozenset[str], LatentsDomainGroupDT]
-LatentsDomainGroupsDT.__doc__ = """
+"""
 Mapping of `LatentsDomainGroupDT`.
 Keys are frozenset of domains matched in the group.
 Each group is independent and contains different data (unpaired).
@@ -71,7 +74,7 @@
 """
 
 RawDomainGroupsT = Mapping[frozenset[str], RawDomainGroupT]
-RawDomainGroupsT.__doc__ = """
+"""
 Mapping of `RawDomainGroupT`. Keys are frozenset of domains matched in the group.
 Each group is independent and contains different data (unpaired).
 
@@ -81,7 +84,7 @@
 """
 
 RawDomainGroupsDT = dict[frozenset[str], RawDomainGroupDT]
-RawDomainGroupsDT.__doc__ = """
+"""
 Mapping of `RawDomainGroupT`. Keys are frozenset of domains matched in the group.
 Each group is independent and contains different data (unpaired).
 
@@ -93,7 +96,7 @@
 """
 
 ModelModeT = Literal["train", "val", "test", "val/ood", "test/ood"]
-ModelModeT.__doc__ = """Mode used by pytorch lightning.
+"""Mode used by pytorch lightning.
 
 ```python
     ModelModeT = Literal["train", "val", "test", "val/ood", "test/ood"]