Skip to content

C++ type names appear in the docstrings #262

@HinTak

Description

@HinTak

Split off from #261,
https://pybind11.readthedocs.io/en/latest/advanced/misc.html#avoiding-cpp-types-in-docstrings

Basically the class declarations need to appear before the methods which involve them. Some can be fixed by init order, such as the Unicode class is only needed/used by the paragraph class, and perhaps the shaper class if it gets more substantial. The rest involves large rearrangements of code, for example canvas has methods involving surface and vice versa, likewise pixmap and image, etc. Some of it will go away as we remove/disable unstable APIs. Probably something to revisit before a non-beta release.

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions