Skip to content

Discuss adding :meta private: to the doc string #1502

Open
@bearomorphism

Description

@bearomorphism
Contributor

We probably can try something like adding :meta private: to the doc string instead. Even though it's a sphinx thing, I think this should be sufficient

Originally posted by @Lee-W in #1466 (comment)

Activity

Lee-W

Lee-W commented on Jun 5, 2025

@Lee-W
Member

it's more like choose between _func_name and :meta private:. We use both in Airflow. But Airflow uses Sphinx. can discuss a bit on what we want

Lee-W

Lee-W commented on Jun 5, 2025

@Lee-W
Member

relates to #1446

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

      Development

      No branches or pull requests

        Participants

        @Lee-W@bearomorphism

        Issue actions

          Discuss adding `:meta private:` to the doc string · Issue #1502 · commitizen-tools/commitizen