Skip to content

Overlay: small improvements to documentation

Daniel Boles requested to merge wip/dboles/overlay-docs-3 into gtk-3-24

This isn't directly applicable to master but might be translatable; I haven't investigated what's changed there yet.

commit 816b4b49ee2146151c0c042f105ff253f4054d96
Author: Daniel Boles <dboles.src@gmail.com>
Date:   Wed Jun 12 17:52:58 2019 +0100

    Overlay: Improve overly brief blurbs @ child props
    
    Be a bit clearer about what :pass-through does, and point :index at the
    corresponding reorder_overlay() method that explains what an index means
commit e1d1ee4ba777638f384aebac87710543fb997804 (HEAD -> wip/dboles/overlay-docs-3, origin/wip/dboles/overlay-docs-3, gtk-3-24)
Author: Daniel Boles <dboles.src@gmail.com>
Date:   Wed Jun 12 17:55:08 2019 +0100

    Overlay: Use documented parameter name @ reorder()
    
    We named the argument `position` in the code and doc arguments, but the
    rest of the documentation referred to `index` instead. That was maybe
    meant to hint at the child property named :index, but we can simply be
    fully clear here. We can call the argument index, replacing the local
    variable with that name, thus avoiding any possible confusion with the
    unrelated ::get-child-position, and refer users to :index for completion

Merge request reports