Skip to content

Conceal 'private' methods from documentation #816

@salvadord

Description

@salvadord

Now "package reference" section lists all the methods/functions across the codebase. But many of them are intended to be private. I suppose sphinx (lib that autogenerates the docs) should have such option to exclude a given method, otherwise, we can try prefixing the private ones with double-underscore.
The ultimate goal is to make only those methods to be discoverable through docs, which are intended to be exposed to the users

Metadata

Metadata

Assignees

No one assigned

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions