Some of the notebooks (e.g. 03) have sections such as:
[6]:
# The `Dataset`` attributes are Python-native dataclasses
dataclasses.fields(dataset.assays[0])
(Field(name='name',type=<class 'str'>,default=<dataclasses._MISSING_TYPE object at 0x101ad5fd0>,default_factory=<dataclasses._MISSING_TYPE object at 0x101ad5fd0>,init=True,repr=True,hash=None,compare=True,metadata=mappingproxy({}),kw_only=True,doc=None,_field_type=_FIELD),
Field(name='description',type=str | None,default=None,default_factory=<dataclasses._MISSING_TYPE object at 0x101ad5fd0>,init=True,repr=True,hash=None,compare=True,metadata=mappingproxy({}),kw_only=True,doc=None,_field_type=_FIELD),
Field(name='fields',type=list[proteingym.base.assay.Field],default=<dataclasses._MISSING_TYPE object at 0x101ad5fd0>,default_factory=<function AssayRaw.<lambda> at 0x11eff6610>,init=True,repr=True,hash=None,compare=True,metadata=mappingproxy({}),kw_only=True,doc=None,_field_type=_FIELD),
Field(name='records',type=list[tuple[proteingym.base.sequence.Sequence | str | int | float | bool | None, ...]],default=<dataclasses._MISSING_TYPE object at 0x101ad5fd0>,default_factory=<class 'list'>,init=True,repr=True,hash=None,compare=True,metadata=mappingproxy({}),kw_only=True,doc=None,_field_type=_FIELD),
Field(name='variables',type=dict[str, int | float | bool | str],default=<dataclasses._MISSING_TYPE object at 0x101ad5fd0>,default_factory=<class 'dict'>,init=True,repr=True,hash=None,compare=True,metadata=mappingproxy({}),kw_only=True,doc=None,_field_type=_FIELD),
Field(name='non_targets',type=list[proteingym.base.assay.Field],default=<dataclasses._MISSING_TYPE object at 0x101ad5fd0>,default_factory=<class 'list'>,init=True,repr=True,hash=None,compare=True,metadata=mappingproxy({}),kw_only=True,doc=None,_field_type=_FIELD))
Which is not really informative for the notebooks, lets make sure we keep them centered around the tutorials of usage and move technical implementation details to the documentation.
Notebooks should be tutorials and know-how's, technical details can be described in the documentation.
Summary
Some of the notebooks (e.g. 03) have sections such as:
returning:
Which is not really informative for the notebooks, lets make sure we keep them centered around the tutorials of usage and move technical implementation details to the documentation.
Motivation
Notebooks should be tutorials and know-how's, technical details can be described in the documentation.
Proposed solution
No response