Skip to content
This repository has been archived by the owner on Apr 26, 2023. It is now read-only.

Section for property/descriptor documentation #22

Open
McSinyx opened this issue Apr 9, 2020 · 0 comments
Open

Section for property/descriptor documentation #22

McSinyx opened this issue Apr 9, 2020 · 0 comments

Comments

@McSinyx
Copy link

McSinyx commented Apr 9, 2020

As raised in our project McSinyx/palace#64, there is not yet any canonical way too document descriptors properly. A case in point is

setter = lambda fset: property(fset=fset, doc=fset.__doc__)

@setter
def auxiliary_send(self, value: Tuple[AuxiliaryEffectSlot, int]) -> None:
    """Connect the effect slot to the given send path.

    Any filter properties on the send path remain as they were.
    """
    self.impl.set_auxiliary_send(
        (<AuxiliaryEffectSlot> value[0]).impl, value[1])

Currently we use Parameters which is not exactly intuitive to the readers. Furthermore, the type of the property is not annotated in the rendered document.

Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant